3 Copyright (C) Dean Camera, 2012.
\r
5 dean [at] fourwalledcubicle [dot] com
\r
10 Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
\r
12 Permission to use, copy, modify, distribute, and sell this
\r
13 software and its documentation for any purpose is hereby granted
\r
14 without fee, provided that the above copyright notice appear in
\r
15 all copies and that both that the copyright notice and this
\r
16 permission notice and warranty disclaimer appear in supporting
\r
17 documentation, and that the name of the author not be used in
\r
18 advertising or publicity pertaining to distribution of the
\r
19 software without specific, written prior permission.
\r
21 The author disclaim all warranties with regard to this
\r
22 software, including all implied warranties of merchantability
\r
23 and fitness. In no event shall the author be liable for any
\r
24 special, indirect or consequential damages or any damages
\r
25 whatsoever resulting from loss of use, data or profits, whether
\r
26 in an action of contract, negligence or other tortious action,
\r
27 arising out of or in connection with the use or performance of
\r
32 * \brief USB Configuration Descriptor definitions.
\r
33 * \copydetails Group_ConfigDescriptorParser
\r
35 * \note This file should not be included directly. It is automatically included as needed by the USB driver
\r
36 * dispatch header located in LUFA/Drivers/USB/USB.h.
\r
39 /** \ingroup Group_StdDescriptors
\r
40 * \defgroup Group_ConfigDescriptorParser Configuration Descriptor Parser
\r
41 * \brief USB Configuration Descriptor definitions.
\r
43 * This section of the library gives a friendly API which can be used in host applications to easily
\r
44 * parse an attached device's configuration descriptor so that endpoint, interface and other descriptor
\r
45 * data can be extracted and used as needed.
\r
50 #ifndef __CONFIGDESCRIPTOR_H__
\r
51 #define __CONFIGDESCRIPTOR_H__
\r
54 #include "../../../Common/Common.h"
\r
55 #include "USBMode.h"
\r
56 #include "HostStandardReq.h"
\r
57 #include "StdDescriptors.h"
\r
59 /* Enable C linkage for C++ Compilers: */
\r
60 #if defined(__cplusplus)
\r
64 /* Preprocessor Checks: */
\r
65 #if !defined(__INCLUDE_FROM_USB_DRIVER)
\r
66 #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
\r
69 /* Public Interface - May be used in end-application: */
\r
71 /** Casts a pointer to a descriptor inside the configuration descriptor into a pointer to the given
\r
76 * uint8_t* CurrDescriptor = &ConfigDescriptor[0]; // Pointing to the configuration header
\r
77 * USB_Descriptor_Configuration_Header_t* ConfigHeaderPtr = DESCRIPTOR_PCAST(CurrDescriptor,
\r
78 * USB_Descriptor_Configuration_Header_t);
\r
80 * // Can now access elements of the configuration header struct using the -> indirection operator
\r
83 #define DESCRIPTOR_PCAST(DescriptorPtr, Type) ((Type*)(DescriptorPtr))
\r
85 /** Casts a pointer to a descriptor inside the configuration descriptor into the given descriptor
\r
86 * type (as an actual struct instance rather than a pointer to a struct).
\r
90 * uint8_t* CurrDescriptor = &ConfigDescriptor[0]; // Pointing to the configuration header
\r
91 * USB_Descriptor_Configuration_Header_t ConfigHeader = DESCRIPTOR_CAST(CurrDescriptor,
\r
92 * USB_Descriptor_Configuration_Header_t);
\r
94 * // Can now access elements of the configuration header struct using the . operator
\r
97 #define DESCRIPTOR_CAST(DescriptorPtr, Type) (*DESCRIPTOR_PCAST(DescriptorPtr, Type))
\r
99 /** Returns the descriptor's type, expressed as the 8-bit type value in the header of the descriptor.
\r
100 * This value's meaning depends on the descriptor's placement in the descriptor, but standard type
\r
101 * values can be accessed in the \ref USB_DescriptorTypes_t enum.
\r
103 #define DESCRIPTOR_TYPE(DescriptorPtr) DESCRIPTOR_PCAST(DescriptorPtr, USB_Descriptor_Header_t)->Type
\r
105 /** Returns the descriptor's size, expressed as the 8-bit value indicating the number of bytes. */
\r
106 #define DESCRIPTOR_SIZE(DescriptorPtr) DESCRIPTOR_PCAST(DescriptorPtr, USB_Descriptor_Header_t)->Size
\r
108 /* Type Defines: */
\r
109 /** Type define for a Configuration Descriptor comparator function (function taking a pointer to an array
\r
110 * of type void, returning a uint8_t value).
\r
112 * \see \ref USB_GetNextDescriptorComp function for more details.
\r
114 typedef uint8_t (* ConfigComparatorPtr_t)(void*);
\r
117 /** Enum for the possible return codes of the \ref USB_Host_GetDeviceConfigDescriptor() function. */
\r
118 enum USB_Host_GetConfigDescriptor_ErrorCodes_t
\r
120 HOST_GETCONFIG_Successful = 0, /**< No error occurred while retrieving the configuration descriptor. */
\r
121 HOST_GETCONFIG_DeviceDisconnect = 1, /**< The attached device was disconnected while retrieving the configuration
\r
124 HOST_GETCONFIG_PipeError = 2, /**< An error occurred in the pipe while sending the request. */
\r
125 HOST_GETCONFIG_SetupStalled = 3, /**< The attached device stalled the request to retrieve the configuration
\r
128 HOST_GETCONFIG_SoftwareTimeOut = 4, /**< The request or data transfer timed out. */
\r
129 HOST_GETCONFIG_BuffOverflow = 5, /**< The device's configuration descriptor is too large to fit into the allocated
\r
132 HOST_GETCONFIG_InvalidData = 6, /**< The device returned invalid configuration descriptor data. */
\r
135 /** Enum for return values of a descriptor comparator function. */
\r
136 enum DSearch_Return_ErrorCodes_t
\r
138 DESCRIPTOR_SEARCH_Found = 0, /**< Current descriptor matches comparator criteria. */
\r
139 DESCRIPTOR_SEARCH_Fail = 1, /**< No further descriptor could possibly match criteria, fail the search. */
\r
140 DESCRIPTOR_SEARCH_NotFound = 2, /**< Current descriptor does not match comparator criteria. */
\r
143 /** Enum for return values of \ref USB_GetNextDescriptorComp(). */
\r
144 enum DSearch_Comp_Return_ErrorCodes_t
\r
146 DESCRIPTOR_SEARCH_COMP_Found = 0, /**< Configuration descriptor now points to descriptor which matches
\r
147 * search criteria of the given comparator function. */
\r
148 DESCRIPTOR_SEARCH_COMP_Fail = 1, /**< Comparator function returned \ref DESCRIPTOR_SEARCH_Fail. */
\r
149 DESCRIPTOR_SEARCH_COMP_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */
\r
152 /* Function Prototypes: */
\r
153 /** Retrieves the configuration descriptor data from an attached device via a standard request into a buffer,
\r
154 * including validity and size checking to prevent a buffer overflow.
\r
156 * \param[in] ConfigNumber Device configuration descriptor number to fetch from the device (usually set to 1 for
\r
157 * single configuration devices).
\r
158 * \param[in,out] ConfigSizePtr Pointer to a location for storing the retrieved configuration descriptor size.
\r
159 * \param[out] BufferPtr Pointer to the buffer for storing the configuration descriptor data.
\r
160 * \param[out] BufferSize Size of the allocated buffer where the configuration descriptor is to be stored.
\r
162 * \return A value from the \ref USB_Host_GetConfigDescriptor_ErrorCodes_t enum.
\r
164 uint8_t USB_Host_GetDeviceConfigDescriptor(const uint8_t ConfigNumber,
\r
165 uint16_t* const ConfigSizePtr,
\r
166 void* const BufferPtr,
\r
167 const uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(3);
\r
169 /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value.
\r
170 * The bytes remaining value is automatically decremented.
\r
172 * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor.
\r
173 * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor.
\r
174 * \param[in] Type Descriptor type value to search for.
\r
176 void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,
\r
177 void** const CurrConfigLoc,
\r
178 const uint8_t Type)
\r
179 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
\r
181 /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value,
\r
182 * which must come before a descriptor of the second given type value. If the BeforeType type
\r
183 * descriptor is reached first, the number of bytes remaining to process is set to zero and the
\r
184 * function exits. The bytes remaining value is automatically decremented.
\r
186 * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor.
\r
187 * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor.
\r
188 * \param[in] Type Descriptor type value to search for.
\r
189 * \param[in] BeforeType Descriptor type value which must not be reached before the given Type descriptor.
\r
191 void USB_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,
\r
192 void** const CurrConfigLoc,
\r
193 const uint8_t Type,
\r
194 const uint8_t BeforeType)
\r
195 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
\r
197 /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value,
\r
198 * which must come after a descriptor of the second given type value. The bytes remaining value is
\r
199 * automatically decremented.
\r
201 * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor.
\r
202 * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor.
\r
203 * \param[in] Type Descriptor type value to search for.
\r
204 * \param[in] AfterType Descriptor type value which must be reached before the given Type descriptor.
\r
206 void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,
\r
207 void** const CurrConfigLoc,
\r
208 const uint8_t Type,
\r
209 const uint8_t AfterType)
\r
210 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
\r
212 /** Searches for the next descriptor in the given configuration descriptor using a pre-made comparator
\r
213 * function. The routine updates the position and remaining configuration descriptor bytes values
\r
214 * automatically. If a comparator routine fails a search, the descriptor pointer is retreated back
\r
215 * so that the next descriptor search invocation will start from the descriptor which first caused the
\r
216 * original search to fail. This behavior allows for one comparator to be used immediately after another
\r
217 * has failed, starting the second search from the descriptor which failed the first.
\r
219 * Comparator functions should be standard functions which accept a pointer to the header of the current
\r
220 * descriptor inside the configuration descriptor which is being compared, and should return a value from
\r
221 * the \ref DSearch_Return_ErrorCodes_t enum as a uint8_t value.
\r
223 * \note This function is available in USB Host mode only.
\r
225 * \param[in,out] BytesRem Pointer to an int storing the remaining bytes in the configuration descriptor.
\r
226 * \param[in,out] CurrConfigLoc Pointer to the current position in the configuration descriptor.
\r
227 * \param[in] ComparatorRoutine Name of the comparator search function to use on the configuration descriptor.
\r
229 * \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum.
\r
233 * uint8_t EndpointSearcher(void* CurrentDescriptor); // Comparator Prototype
\r
235 * uint8_t EndpointSearcher(void* CurrentDescriptor)
\r
237 * if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
\r
238 * return DESCRIPTOR_SEARCH_Found;
\r
240 * return DESCRIPTOR_SEARCH_NotFound;
\r
245 * // After retrieving configuration descriptor:
\r
246 * if (USB_Host_GetNextDescriptorComp(&BytesRemaining, &CurrentConfigLoc, EndpointSearcher) ==
\r
247 * Descriptor_Search_Comp_Found)
\r
249 * // Do something with the endpoint descriptor
\r
253 uint8_t USB_GetNextDescriptorComp(uint16_t* const BytesRem,
\r
254 void** const CurrConfigLoc,
\r
255 ConfigComparatorPtr_t const ComparatorRoutine);
\r
257 /* Inline Functions: */
\r
258 /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then
\r
259 points to the next sub-descriptor. The bytes remaining value is automatically decremented.
\r
261 * \param[in,out] BytesRem Pointer to the number of bytes remaining of the configuration descriptor.
\r
262 * \param[in,out] CurrConfigLoc Pointer to the current descriptor inside the configuration descriptor.
\r
264 static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
\r
265 void** CurrConfigLoc) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
\r
266 static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
\r
267 void** CurrConfigLoc)
\r
269 uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).Size;
\r
271 if (*BytesRem < CurrDescriptorSize)
\r
272 CurrDescriptorSize = *BytesRem;
\r
274 *CurrConfigLoc = (void*)((uintptr_t)*CurrConfigLoc + CurrDescriptorSize);
\r
275 *BytesRem -= CurrDescriptorSize;
\r
278 /* Disable C linkage for C++ Compilers: */
\r
279 #if defined(__cplusplus)
\r