ConfigDescriptor.h 14.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

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

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, provided that the above copyright notice appear in 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
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Configuration descriptor parser API. This section of the library gives a friendly API which can be used in
 *  host applications to easily parse an attached device's configuration descriptor so that endpoint, interface
 *  and other descriptor data can be extracted and used as needed.
 */

38
39
40
41
42
43
44
45
/** \ingroup Group_Descriptors
 *  @defgroup Group_ConfigDescriptorParser Configuration Descriptor Parser
 *
 *  Functions, macros, variables, enums and types related to the parsing of Configuration Descriptors.
 *
 *  @{
 */

46
47
48
49
50
51
52
#ifndef __CONFIGDESCRIPTOR_H__
#define __CONFIGDESCRIPTOR_H__

	/* Includes: */
		#include <avr/io.h>
		
		#include "../../../Common/Common.h"
53
		#include "../HighLevel/USBMode.h"
54
55
56
57
58
59
60
61
		#include "../LowLevel/HostChapter9.h"
		#include "../HighLevel/StdDescriptors.h"
		
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

62
	/* Public Interface - May be used in end-application: */	
63
		/* Macros: */
64
65
66
67
68
			/** 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.
			 */
			#define EP_TYPE_MASK                       0x03

69
70
71
72
73
74
75
76
77
78
79
80
			/** Casts a pointer to a descriptor inside the configuration descriptor into a pointer to the given
			 *  descriptor type.
			 *
			 *  Usage Example:
			 *  \code
			 *  uint8_t* CurrDescriptor = &ConfigDescriptor[0]; // Pointing to the configuration header
			 *  USB_Descriptor_Configuration_Header_t* ConfigHeaderPtr = DESCRIPTOR_PCAST(CurrDescriptor,
			 *                                                           USB_Descriptor_Configuration_Header_t);
			 *
			 *  // Can now access elements of the configuration header struct using the -> indirection operator
			 *  \endcode
			 */
81
			#define DESCRIPTOR_PCAST(DescriptorPtr, Type) ((Type*)(DescriptorPtr))
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

			/** Casts a pointer to a descriptor inside the configuration descriptor into the given descriptor
			 *  type (as an actual struct instance rather than a pointer to a struct).
			 *
			 *  Usage Example:
			 *  \code
			 *  uint8_t* CurrDescriptor = &ConfigDescriptor[0]; // Pointing to the configuration header
			 *  USB_Descriptor_Configuration_Header_t ConfigHeader = DESCRIPTOR_CAST(CurrDescriptor,
			 *                                                       USB_Descriptor_Configuration_Header_t);
			 *
			 *  // Can now access elements of the configuration header struct using the . operator
			 *  \endcode
			 */
			#define DESCRIPTOR_CAST(DescriptorPtr, Type)  (*DESCRIPTOR_PCAST(DescriptorPtr, Type))

			/** Returns the descriptor's type, expressed as the 8-bit type value in the header of the descriptor.
			 *  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
107
108

		/* Type Defines: */
			/** Type define for a Configuration Descriptor comparator function (function taking a pointer to an array
			 *  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*);
113

114
115
116
117
118
119
120
121
122
123
124
125
126
127
		/* Function Prototypes: */
			/** Searches for the next descriptor in the given configuration descriptor using a premade comparator
			 *  function. The routine updates the position and remaining configuration descriptor bytes values
			 *  automatically. If a comparator routine fails a search, the descriptor pointer is retreated back
			 *  so that the next descriptor search invocation will start from the descriptor which first caused the
			 *  original search to fail. This behaviour allows for one comparator to be used immediately after another
			 *  has failed, starting the second search from the descriptor which failed the first.
			 *
			 *  Comparator functions should be standard functions which accept a pointer to the header of the current
			 *  descriptor inside the configuration descriptor which is being compared, and should return a value from
			 *  the \ref DSearch_Return_ErrorCodes_t enum as a uint8_t value.
			 *
			 *  \note This function is available in USB Host mode only.
			 *
128
129
130
			 *  \param[in,out] BytesRem  Pointer to an int storing the remaining bytes in the configuration descriptor
			 *  \param[in,out] CurrConfigLoc  Pointer to the current position in the configuration descriptor
			 *  \param[in] ComparatorRoutine  Name of the comparator search function to use on the configuration descriptor
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
			 *
			 *  \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum
			 *
			 *  Usage Example:
			 *  \code
			 *  uint8_t EndpointSearcher(void* CurrentDescriptor); // Comparator Prototype
			 *
			 *  uint8_t EndpointSearcher(void* CurrentDescriptor)
			 *  {
			 *     if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
			 *         return DESCRIPTOR_SEARCH_Found;
			 *     else
			 *         return DESCRIPTOR_SEARCH_NotFound;
			 *  }
			 *
			 *  //...
			 *  // After retrieving configuration descriptor:
148
			 *  if (USB_Host_GetNextDescriptorComp(&BytesRemaining, &CurrentConfigLoc, EndpointSearcher) ==
149
150
151
152
153
154
			 *      Descriptor_Search_Comp_Found)
			 *  {
			 *      // Do something with the endpoint descriptor
			 *  }
			 *  \endcode
			 */
155
			uint8_t USB_GetNextDescriptorComp(uint16_t* BytesRem, void** CurrConfigLoc, ConfigComparatorPtr_t ComparatorRoutine);
156
			
157
		/* Enums: */
158
			/** Enum for the possible return codes of the \ref USB_Host_GetDeviceConfigDescriptor() function. */
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
			enum USB_Host_GetConfigDescriptor_ErrorCodes_t
			{
				HOST_GETCONFIG_Successful       = 0, /**< No error occurred while retrieving the configuration descriptor */
				HOST_GETCONFIG_DeviceDisconnect = 1, /**< The attached device was disconnected while retrieving the configuration
				                                        * descriptor
				                                        */
				HOST_GETCONFIG_PipeError        = 2, /**< An error occurred in the pipe while sending the request */
				HOST_GETCONFIG_SetupStalled     = 3, /**< The attached device stalled the request to retrieve the configuration
				                                        * descriptor
				                                        */
				HOST_GETCONFIG_SoftwareTimeOut  = 4, /**< The request or data transfer timed out */
				HOST_GETCONFIG_BuffOverflow     = 5, /**< The device's configuration descriptor is too large to fit into the allocated
				                                        * buffer
				                                        */
				HOST_GETCONFIG_InvalidData      = 6, /**< The device returned invalid configuration descriptor data */
			};
		
176
			/** Enum for return values of a descriptor comparator function. */
177
			enum DSearch_Return_ErrorCodes_t
178
			{
179
180
181
				DESCRIPTOR_SEARCH_Found                = 0, /**< Current descriptor matches comparator criteria. */
				DESCRIPTOR_SEARCH_Fail                 = 1, /**< No further descriptor could possibly match criteria, fail the search. */
				DESCRIPTOR_SEARCH_NotFound             = 2, /**< Current descriptor does not match comparator criteria. */
182
183
			};

184
			/** Enum for return values of \ref USB_GetNextDescriptorComp(). */
185
			enum DSearch_Comp_Return_ErrorCodes_t
186
			{
187
				DESCRIPTOR_SEARCH_COMP_Found           = 0, /**< Configuration descriptor now points to descriptor which matches
188
				                                             *   search criteria of the given comparator function. */
189
190
				DESCRIPTOR_SEARCH_COMP_Fail            = 1, /**< Comparator function returned Descriptor_Search_Fail. */
				DESCRIPTOR_SEARCH_COMP_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */
191
192
193
			};
	
		/* Function Prototypes: */
194
195
			/** 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.
196
			 *
197
198
			 *  \param[in] ConfigNumber  Device configuration descriptor number to fetch from the device (usually set to 1 for
			 *                           single configuration devices)
199
200
201
			 *  \param[in,out] ConfigSizePtr  Pointer to a uint16_t for storing the retrieved configuration descriptor size
			 *  \param[out] BufferPtr  Pointer to the buffer for storing the configuration descriptor data.
			 *  \param[out] BufferSize  Size of the allocated buffer where the configuration descriptor is to be stored
202
			 *
203
			 *  \return A value from the \ref USB_Host_GetConfigDescriptor_ErrorCodes_t enum
204
			 */
205
			uint8_t USB_Host_GetDeviceConfigDescriptor(uint8_t ConfigNumber, uint16_t* const ConfigSizePtr, void* BufferPtr,
206
			                                           uint16_t BufferSize) ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(3);
207
208
209
210

			/** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value.
			 *  The bytes remaining value is automatically decremented.
			 *
211
212
213
			 * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
			 * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
			 * \param[in] Type  Descriptor type value to search for
214
			 */
215
			void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,
216
			                                 void** const CurrConfigLoc,
217
			                                 const uint8_t Type)
218
			                                 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
219
220
221
222
223
224

			/** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value,
			 *  which must come before a descriptor of the second given type value. If the BeforeType type
			 *  descriptor is reached first, the number of bytes remaining to process is set to zero and the
			 *  function exits. The bytes remaining value is automatically decremented.
			 *
225
226
227
228
			 * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
			 * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
			 * \param[in] Type  Descriptor type value to search for
			 * \param[in] BeforeType  Descriptor type value which must not be reached before the given Type descriptor
229
			 */
230
			void USB_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,
231
			                                       void** const CurrConfigLoc,
232
233
			                                       const uint8_t Type,
			                                       const uint8_t BeforeType)
234
			                                       ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
235
236
237
238
239

			/** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value,
			 *  which must come after a descriptor of the second given type value. The bytes remaining value is
			 *  automatically decremented.
			 *
240
241
242
243
			 * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
			 * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
			 * \param[in] Type  Descriptor type value to search for
			 * \param[in] AfterType  Descriptor type value which must be reached before the given Type descriptor
244
			 */
245
			void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,
246
			                                      void** const CurrConfigLoc,
247
248
			                                      const uint8_t Type,
			                                      const uint8_t AfterType)
249
			                                      ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
250
251
252
253
254

		/* Inline Functions: */
			/** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then
			    points to the next sub-descriptor. The bytes remaining value is automatically decremented.
			 *
255
256
			 * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
			 * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
257
258
			 */
			static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
259
			                                         void** const CurrConfigLoc) 
260
			                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);									  
261
			static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
262
			                                         void** const CurrConfigLoc)
263
264
265
			{
				uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).Size;

266
				*((uint8_t**)CurrConfigLoc) += CurrDescriptorSize;
267
				*BytesRem      -= CurrDescriptorSize;
268
			}
269
270
271
272
273
			
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
274

275
#endif
276
277

/** @} */