Descriptors.c 13.7 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
38
39
/*
             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
 *
 *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special 
 *  computer-readable structures which the host requests upon device enumeration, to determine
 *  the device's capabilities and functions.  
 */

#include "Descriptors.h"

40
41
42
43
44
45
46
47
48
49
50
51
/* On some devices, there is a factory set internal serial number which can be automatically sent to the host as
 * the device's serial number when the Device Descriptor's .SerialNumStrIndex entry is set to USE_INTERNAL_SERIAL.
 * This allows the host to track a device across insertions on different ports, allowing them to retain allocated
 * resources like COM port numbers and drivers. On demos using this feature, give a warning on unsupported devices
 * so that the user can supply their own serial number descriptor instead or remove the USE_INTERNAL_SERIAL value
 * from the Device Descriptor (forcing the host to generate a serial number for each device from the VID, PID and
 * port location).
 */
#if (USE_INTERNAL_SERIAL == NO_DESCRIPTOR)
	#warning USE_INTERNAL_SERIAL is not available on this AVR - please manually construct a device serial descriptor.
#endif

52
53
54
55
56
57
58
/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
 *  device characteristics, including the supported USB version, control endpoint size and the
 *  number of device configurations. The descriptor is read out by the USB host when the enumeration
 *  process begins.
 */
USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
{
59
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
60
		
61
62
63
64
	.USBSpecification       = VERSION_BCD(01.10),
	.Class                  = 0xEF,
	.SubClass               = 0x02,
	.Protocol               = 0x01,
65
				
66
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
67
		
68
69
70
	.VendorID               = 0x03EB,
	.ProductID              = 0x204E,
	.ReleaseNumber          = 0x0000,
71
		
72
73
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
74
	.SerialNumStrIndex      = USE_INTERNAL_SERIAL,
75
		
76
	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
77
78
79
80
81
82
83
84
85
};

/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
 *  of the device in one of its supported configurations, including information about any device interfaces
 *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
 *  a configuration so that the host may correctly communicate with the USB device.
 */
USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
{
86
	.Config = 
87
		{
88
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
89

90
91
			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 4,
92
				
93
94
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
95
				
96
			.ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
97
			
98
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
99
100
		},
		
101
	.IAD1 = 
102
		{
103
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},
104

105
106
			.FirstInterfaceIndex    = 0,
			.TotalInterfaces        = 2,
107

108
109
110
			.Class                  = 0x02,
			.SubClass               = 0x02,
			.Protocol               = 0x01,
111

112
			.IADStrIndex            = NO_DESCRIPTOR
113
114
		},

115
	.CDC1_CCI_Interface = 
116
		{
117
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
118

119
120
			.InterfaceNumber        = 0,
			.AlternateSetting       = 0,
121
			
122
			.TotalEndpoints         = 1,
123
				
124
125
126
			.Class                  = 0x02,
			.SubClass               = 0x02,
			.Protocol               = 0x01,
127
				
128
			.InterfaceStrIndex      = NO_DESCRIPTOR
129
130
		},

131
	.CDC1_Functional_IntHeader = 
132
		{
133
134
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x00,
135
			
136
			.Data                   = {0x01, 0x10}
137
138
		},

139
	.CDC1_Functional_CallManagement = 
140
		{
141
142
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x01,
143
			
144
			.Data                   = {0x03, 0x01}
145
146
		},

147
	.CDC1_Functional_AbstractControlManagement = 
148
		{
149
150
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
			.SubType                = 0x02,
151
			
152
			.Data                   = {0x06}
153
154
		},
		
155
	.CDC1_Functional_Union = 
156
		{
157
158
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x06,
159
			
160
			.Data                   = {0x00, 0x01}
161
162
		},

163
	.CDC1_ManagementEndpoint = 
164
		{
165
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
166
										 
167
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC1_NOTIFICATION_EPNUM),
168
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
169
170
			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
			.PollingIntervalMS      = 0xFF
171
172
		},

173
	.CDC1_DCI_Interface = 
174
		{
175
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
176

177
178
			.InterfaceNumber        = 1,
			.AlternateSetting       = 0,
179
			
180
			.TotalEndpoints         = 2,
181
				
182
183
184
			.Class                  = 0x0A,
			.SubClass               = 0x00,
			.Protocol               = 0x00,
185
				
186
			.InterfaceStrIndex      = NO_DESCRIPTOR
187
188
		},

189
	.CDC1_DataOutEndpoint = 
190
		{
191
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
192
										 
193
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC1_RX_EPNUM),
194
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
195
196
			.EndpointSize           = CDC_TXRX_EPSIZE,
			.PollingIntervalMS      = 0x00
197
198
		},
		
199
	.CDC1_DataInEndpoint = 
200
		{
201
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
202
										 
203
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC1_TX_EPNUM),
204
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
205
206
			.EndpointSize           = CDC_TXRX_EPSIZE,
			.PollingIntervalMS      = 0x00
207
208
		},

209
	.IAD2 = 
210
		{
211
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},
212

213
214
			.FirstInterfaceIndex    = 2,
			.TotalInterfaces        = 2,
215

216
217
218
			.Class                  = 0x02,
			.SubClass               = 0x02,
			.Protocol               = 0x01,
219

220
			.IADStrIndex            = NO_DESCRIPTOR
221
222
		},

223
	.CDC2_CCI_Interface = 
224
		{
225
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
226

227
228
			.InterfaceNumber        = 2,
			.AlternateSetting       = 0,
229
			
230
			.TotalEndpoints         = 1,
231
				
232
233
234
			.Class                  = 0x02,
			.SubClass               = 0x02,
			.Protocol               = 0x01,
235
				
236
			.InterfaceStrIndex      = NO_DESCRIPTOR
237
238
		},

239
	.CDC2_Functional_IntHeader = 
240
		{
241
242
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x00,
243
			
244
			.Data                   = {0x01, 0x10}
245
246
		},

247
	.CDC2_Functional_CallManagement = 
248
		{
249
250
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x01,
251
			
252
			.Data                   = {0x03, 0x03}
253
254
		},

255
	.CDC2_Functional_AbstractControlManagement = 
256
		{
257
258
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
			.SubType                = 0x02,
259
			
260
			.Data                   = {0x06}
261
262
		},
		
263
	.CDC2_Functional_Union = 
264
		{
265
266
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x06,
267
			
268
			.Data                   = {0x02, 0x03}
269
270
		},

271
	.CDC2_ManagementEndpoint = 
272
		{
273
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
274
										 
275
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC2_NOTIFICATION_EPNUM),
276
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
277
278
			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
			.PollingIntervalMS      = 0xFF
279
280
		},

281
	.CDC2_DCI_Interface = 
282
		{
283
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
284

285
286
			.InterfaceNumber        = 3,
			.AlternateSetting       = 0,
287
			
288
			.TotalEndpoints         = 2,
289
				
290
291
292
			.Class                  = 0x0A,
			.SubClass               = 0x00,
			.Protocol               = 0x00,
293
				
294
			.InterfaceStrIndex      = NO_DESCRIPTOR
295
296
		},

297
	.CDC2_DataOutEndpoint = 
298
		{
299
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
300
										 
301
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC2_RX_EPNUM),
302
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
303
304
			.EndpointSize           = CDC_TXRX_EPSIZE,
			.PollingIntervalMS      = 0x00
305
306
		},
		
307
	.CDC2_DataInEndpoint = 
308
		{
309
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
310
										 
311
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC2_TX_EPNUM),
312
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
313
314
			.EndpointSize           = CDC_TXRX_EPSIZE,
			.PollingIntervalMS      = 0x00
315
316
317
318
319
320
321
322
323
		}
};

/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 */
USB_Descriptor_String_t PROGMEM LanguageString =
{
324
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
325
		
326
	.UnicodeString          = {LANGUAGE_ID_ENG}
327
328
329
330
331
332
333
334
};

/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 *  Descriptor.
 */
USB_Descriptor_String_t PROGMEM ManufacturerString =
{
335
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
336
		
337
	.UnicodeString          = L"Dean Camera"
338
339
340
341
342
343
344
345
};

/** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 *  Descriptor.
 */
USB_Descriptor_String_t PROGMEM ProductString =
{
346
	.Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},
347
		
348
	.UnicodeString          = L"LUFA Dual CDC Demo"
349
350
};

351
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
352
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
353
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
354
355
356
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 *  USB host.
 */
357
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
358
359
360
361
362
363
364
365
366
367
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

	void*    Address = NULL;
	uint16_t Size    = NO_DESCRIPTOR;

	switch (DescriptorType)
	{
		case DTYPE_Device:
368
			Address = (void*)&DeviceDescriptor;
369
370
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
371
		case DTYPE_Configuration: 
372
			Address = (void*)&ConfigurationDescriptor;
373
374
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
375
		case DTYPE_String: 
376
377
			switch (DescriptorNumber)
			{
378
				case 0x00: 
379
					Address = (void*)&LanguageString;
380
381
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
382
				case 0x01: 
383
					Address = (void*)&ManufacturerString;
384
385
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
386
				case 0x02: 
387
					Address = (void*)&ProductString;
388
389
390
391
392
393
394
395
396
397
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
			
			break;
	}
	
	*DescriptorAddress = Address;	
	return Size;
}