LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Configuration descriptor parser API. This section of the library gives a friendly API which can be used in
  34  *  host applications to easily parse an attached device's configuration descriptor so that endpoint, interface
  35  *  and other descriptor data can be extracted and used as needed.
  36  */
  37
  38 /** \ingroup Group_Descriptors
  39  *  @defgroup Group_ConfigDescriptorParser Configuration Descriptor Parser
  40  *
  41  *  Functions, macros, variables, enums and types related to the parsing of Configuration Descriptors.
  42  *
  43  *  @{
  44  */
  45
  46 #ifndef __CONFIGDESCRIPTOR_H__
  47 #define __CONFIGDESCRIPTOR_H__
  48
  49         /* Includes: */
  50                 #include <avr/io.h>
  51
  52                 #include "../../../Common/Common.h"
  53                 #include "../HighLevel/USBMode.h"
  54                 #include "../LowLevel/HostChapter9.h"
  55                 #include "../HighLevel/StdDescriptors.h"
  56
  57         /* Enable C linkage for C++ Compilers: */
  58                 #if defined(__cplusplus)
  59                         extern "C" {
  60                 #endif
  61
  62         /* Public Interface - May be used in end-application: */
  63                 /* Macros: */
  64                         /** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared
  65                          *  with the EP_TYPE_* masks to determine the exact type of the endpoint.
  66                          */
  67                         #define EP_TYPE_MASK                       0x03
  68
  69                         /** Casts a pointer to a descriptor inside the configuration descriptor into a pointer to the given
  70                          *  descriptor type.
  71                          *
  72                          *  Usage Example:
  73                          *  \code
  74                          *  uint8_t* CurrDescriptor = &ConfigDescriptor[0]; // Pointing to the configuration header
  75                          *  USB_Descriptor_Configuration_Header_t* ConfigHeaderPtr = DESCRIPTOR_PCAST(CurrDescriptor,
  76                          *                                                           USB_Descriptor_Configuration_Header_t);
  77                          *
  78                          *  // Can now access elements of the configuration header struct using the -> indirection operator
  79                          *  \endcode
  80                          */
  81                         #define DESCRIPTOR_PCAST(DescriptorPtr, Type) ((Type*)DescriptorPtr)
  82
  83                         /** Casts a pointer to a descriptor inside the configuration descriptor into the given descriptor
  84                          *  type (as an actual struct instance rather than a pointer to a struct).
  85                          *
  86                          *  Usage Example:
  87                          *  \code
  88                          *  uint8_t* CurrDescriptor = &ConfigDescriptor[0]; // Pointing to the configuration header
  89                          *  USB_Descriptor_Configuration_Header_t ConfigHeader = DESCRIPTOR_CAST(CurrDescriptor,
  90                          *                                                       USB_Descriptor_Configuration_Header_t);
  91                          *
  92                          *  // Can now access elements of the configuration header struct using the . operator
  93                          *  \endcode
  94                          */
  95                         #define DESCRIPTOR_CAST(DescriptorPtr, Type)  (*DESCRIPTOR_PCAST(DescriptorPtr, Type))
  96
  97                         /** Returns the descriptor's type, expressed as the 8-bit type value in the header of the descriptor.
  98                          *  This value's meaning depends on the descriptor's placement in the descriptor, but standard type
  99                          *  values can be accessed in the \ref USB_DescriptorTypes_t enum.
 100                          */
 101                         #define DESCRIPTOR_TYPE(DescriptorPtr)    DESCRIPTOR_CAST(DescriptorPtr, USB_Descriptor_Header_t).Type
 102
 103                         /** Returns the descriptor's size, expressed as the 8-bit value indicating the number of bytes. */
 104                         #define DESCRIPTOR_SIZE(DescriptorPtr)    DESCRIPTOR_CAST(DescriptorPtr, USB_Descriptor_Header_t).Size
 105
 106                 /* Type Defines: */
 107                         /** Type define for a Configuration Descriptor comparator function (function taking a pointer to an array
 108                          *  of type void, returning a uint8_t value).
 109                          *
 110                          *  \see \ref USB_GetNextDescriptorComp function for more details
 111                          */
 112                         typedef uint8_t (* const ConfigComparatorPtr_t)(void* const);
 113
 114                 /* Function Prototypes: */
 115                         /** Searches for the next descriptor in the given configuration descriptor using a premade comparator
 116                          *  function. The routine updates the position and remaining configuration descriptor bytes values
 117                          *  automatically. If a comparator routine fails a search, the descriptor pointer is retreated back
 118                          *  so that the next descriptor search invocation will start from the descriptor which first caused the
 119                          *  original search to fail. This behaviour allows for one comparator to be used immediately after another
 120                          *  has failed, starting the second search from the descriptor which failed the first.
 121                          *
 122                          *  Comparator functions should be standard functions which accept a pointer to the header of the current
 123                          *  descriptor inside the configuration descriptor which is being compared, and should return a value from
 124                          *  the \ref DSearch_Return_ErrorCodes_t enum as a uint8_t value.
 125                          *
 126                          *  \note This function is available in USB Host mode only.
 127                          *
 128                          *  \param[in,out] BytesRem  Pointer to an int storing the remaining bytes in the configuration descriptor
 129                          *  \param[in,out] CurrConfigLoc  Pointer to the current position in the configuration descriptor
 130                          *  \param[in] ComparatorRoutine  Name of the comparator search function to use on the configuration descriptor
 131                          *
 132                          *  \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum
 133                          *
 134                          *  Usage Example:
 135                          *  \code
 136                          *  uint8_t EndpointSearcher(void* CurrentDescriptor); // Comparator Prototype
 137                          *
 138                          *  uint8_t EndpointSearcher(void* CurrentDescriptor)
 139                          *  {
 140                          *     if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
 141                          *         return DESCRIPTOR_SEARCH_Found;
 142                          *     else
 143                          *         return DESCRIPTOR_SEARCH_NotFound;
 144                          *  }
 145                          *
 146                          *  //...
 147                          *  // After retrieving configuration descriptor:
 148                          *  if (USB_Host_GetNextDescriptorComp(&BytesRemaining, &CurrentConfigLoc, EndpointSearcher) ==
 149                          *      Descriptor_Search_Comp_Found)
 150                          *  {
 151                          *      // Do something with the endpoint descriptor
 152                          *  }
 153                          *  \endcode
 154                          */
 155                         uint8_t USB_GetNextDescriptorComp(uint16_t* BytesRem, uint8_t** CurrConfigLoc, ConfigComparatorPtr_t ComparatorRoutine);
 156
 157                 /* Enums: */
 158                         enum USB_Host_GetConfigDescriptor_ErrorCodes_t
 159                         {
 160                                 HOST_GETCONFIG_Successful       = 0, /**< No error occurred while retrieving the configuration descriptor */
 161                                 HOST_GETCONFIG_DeviceDisconnect = 1, /**< The attached device was disconnected while retrieving the configuration
 162                                                                         * descriptor
 163                                                                         */
 164                                 HOST_GETCONFIG_PipeError        = 2, /**< An error occurred in the pipe while sending the request */
 165                                 HOST_GETCONFIG_SetupStalled     = 3, /**< The attached device stalled the request to retrieve the configuration
 166                                                                         * descriptor
 167                                                                         */
 168                                 HOST_GETCONFIG_SoftwareTimeOut  = 4, /**< The request or data transfer timed out */
 169                                 HOST_GETCONFIG_BuffOverflow     = 5, /**< The device's configuration descriptor is too large to fit into the allocated
 170                                                                         * buffer
 171                                                                         */
 172                                 HOST_GETCONFIG_InvalidData      = 6, /**< The device returned invalid configuration descriptor data */
 173                         };
 174
 175                         /** Enum for return values of a descriptor comparator function. */
 176                         enum DSearch_Return_ErrorCodes_t
 177                         {
 178                                 DESCRIPTOR_SEARCH_Found                = 0, /**< Current descriptor matches comparator criteria. */
 179                                 DESCRIPTOR_SEARCH_Fail                 = 1, /**< No further descriptor could possibly match criteria, fail the search. */
 180                                 DESCRIPTOR_SEARCH_NotFound             = 2, /**< Current descriptor does not match comparator criteria. */
 181                         };
 182
 183                         /** Enum for return values of \ref USB_GetNextDescriptorComp(). */
 184                         enum DSearch_Comp_Return_ErrorCodes_t
 185                         {
 186                                 DESCRIPTOR_SEARCH_COMP_Found           = 0, /**< Configuration descriptor now points to descriptor which matches
 187                                                                              *   search criteria of the given comparator function. */
 188                                 DESCRIPTOR_SEARCH_COMP_Fail            = 1, /**< Comparator function returned Descriptor_Search_Fail. */
 189                                 DESCRIPTOR_SEARCH_COMP_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */
 190                         };
 191
 192                 /* Function Prototypes: */
 193                         /** Retrieves the configuration descriptor data from an attached device via a standard request into a buffer,
 194                          *  including validity and size checking to prevent a buffer overflow.
 195                          *
 196                          *  \param[in] ConfigNumber  Device configuration descriptor number to fetch from the device (usually set to 1 for
 197                          *                           single configuration devices)
 198                          *  \param[in,out] ConfigSizePtr  Pointer to a uint16_t for storing the retrieved configuration descriptor size
 199                          *  \param[out] BufferPtr  Pointer to the buffer for storing the configuration descriptor data.
 200                          *  \param[out] BufferSize  Size of the allocated buffer where the configuration descriptor is to be stored
 201                          *
 202                          *  \return A value from the \ref USB_Host_GetConfigDescriptor_ErrorCodes_t enum
 203                          */
 204                         uint8_t USB_GetDeviceConfigDescriptor(uint8_t ConfigNumber, uint16_t* const ConfigSizePtr, void* BufferPtr,
 205                                                               uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(2, 3);
 206
 207                         /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value.
 208                          *  The bytes remaining value is automatically decremented.
 209                          *
 210                          * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
 211                          * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
 212                          * \param[in] Type  Descriptor type value to search for
 213                          */
 214                         void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,
 215                                                          uint8_t** const CurrConfigLoc,
 216                                                          const uint8_t Type)
 217                                                          ATTR_NON_NULL_PTR_ARG(1, 2);
 218
 219                         /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value,
 220                          *  which must come before a descriptor of the second given type value. If the BeforeType type
 221                          *  descriptor is reached first, the number of bytes remaining to process is set to zero and the
 222                          *  function exits. The bytes remaining value is automatically decremented.
 223                          *
 224                          * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
 225                          * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
 226                          * \param[in] Type  Descriptor type value to search for
 227                          * \param[in] BeforeType  Descriptor type value which must not be reached before the given Type descriptor
 228                          */
 229                         void USB_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,
 230                                                                uint8_t** const CurrConfigLoc,
 231                                                                const uint8_t Type,
 232                                                                const uint8_t BeforeType)
 233                                                                ATTR_NON_NULL_PTR_ARG(1, 2);
 234
 235                         /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value,
 236                          *  which must come after a descriptor of the second given type value. The bytes remaining value is
 237                          *  automatically decremented.
 238                          *
 239                          * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
 240                          * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
 241                          * \param[in] Type  Descriptor type value to search for
 242                          * \param[in] AfterType  Descriptor type value which must be reached before the given Type descriptor
 243                          */
 244                         void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,
 245                                                               uint8_t** const CurrConfigLoc,
 246                                                               const uint8_t Type,
 247                                                               const uint8_t AfterType)
 248                                                               ATTR_NON_NULL_PTR_ARG(1, 2);
 249
 250                 /* Inline Functions: */
 251                         /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then
 252                             points to the next sub-descriptor. The bytes remaining value is automatically decremented.
 253                          *
 254                          * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
 255                          * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
 256                          */
 257                         static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
 258                                                                  uint8_t** const CurrConfigLoc)
 259                                                                  ATTR_NON_NULL_PTR_ARG(1, 2);
 260                         static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
 261                                                                  uint8_t** const CurrConfigLoc)
 262                         {
 263                                 uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).Size;
 264
 265                                 *CurrConfigLoc += CurrDescriptorSize;
 266                                 *BytesRem      -= CurrDescriptorSize;
 267                         }
 268
 269         /* Disable C linkage for C++ Compilers: */
 270                 #if defined(__cplusplus)
 271                         }
 272                 #endif
 273
 274 #endif
 275
 276 /** @} */