Descriptors.c 12.4 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2018.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2018  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
17
18
  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
19
20
  software without specific, written prior permission.

21
  The author disclaims all warranties with regard to this
22
23
24
25
26
27
28
29
30
31
32
  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
 *
33
 *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special
34
 *  computer-readable structures which the host requests upon device enumeration, to determine
35
 *  the device's capabilities and functions.
36
37
38
39
40
41
42
43
44
45
 */

#include "Descriptors.h"


/** 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.
 */
46
const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
47
48
{
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
49

50
	.USBSpecification       = VERSION_BCD(1,1,0),
51
52
53
	.Class                  = USB_CSCP_IADDeviceClass,
	.SubClass               = USB_CSCP_IADDeviceSubclass,
	.Protocol               = USB_CSCP_IADDeviceProtocol,
54

55
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
56

57
58
	.VendorID               = 0x03EB,
	.ProductID              = 0x204E,
59
	.ReleaseNumber          = VERSION_BCD(0,0,1),
60

61
62
	.ManufacturerStrIndex   = STRING_ID_Manufacturer,
	.ProductStrIndex        = STRING_ID_Product,
63
	.SerialNumStrIndex      = USE_INTERNAL_SERIAL,
64

65
66
67
68
69
70
71
72
	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
};

/** 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.
 */
73
const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
74
{
75
	.Config =
76
77
78
79
80
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 4,
81

82
83
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
84

85
			.ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
86

87
88
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
		},
89
90

	.CDC1_IAD =
91
92
93
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},

94
			.FirstInterfaceIndex    = INTERFACE_ID_CDC1_CCI,
95
96
			.TotalInterfaces        = 2,

97
98
99
			.Class                  = CDC_CSCP_CDCClass,
			.SubClass               = CDC_CSCP_ACMSubclass,
			.Protocol               = CDC_CSCP_ATCommandProtocol,
100
101
102
103

			.IADStrIndex            = NO_DESCRIPTOR
		},

104
	.CDC1_CCI_Interface =
105
106
107
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

108
			.InterfaceNumber        = INTERFACE_ID_CDC1_CCI,
109
			.AlternateSetting       = 0,
110

111
			.TotalEndpoints         = 1,
112

113
114
115
			.Class                  = CDC_CSCP_CDCClass,
			.SubClass               = CDC_CSCP_ACMSubclass,
			.Protocol               = CDC_CSCP_ATCommandProtocol,
116

117
118
119
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

120
	.CDC1_Functional_Header =
121
		{
122
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = CDC_DTYPE_CSInterface},
123
			.Subtype                = CDC_DSUBTYPE_CSInterface_Header,
124

125
			.CDCSpecification       = VERSION_BCD(1,1,0),
126
127
		},

128
	.CDC1_Functional_ACM =
129
		{
130
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = CDC_DTYPE_CSInterface},
131
			.Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
132

133
			.Capabilities           = 0x06,
134
		},
135
136

	.CDC1_Functional_Union =
137
		{
138
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = CDC_DTYPE_CSInterface},
139
			.Subtype                = CDC_DSUBTYPE_CSInterface_Union,
140

141
142
			.MasterInterfaceNumber  = INTERFACE_ID_CDC1_CCI,
			.SlaveInterfaceNumber   = INTERFACE_ID_CDC1_DCI,
143
144
		},

145
	.CDC1_ManagementEndpoint =
146
147
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
148

149
			.EndpointAddress        = CDC1_NOTIFICATION_EPADDR,
150
151
152
153
154
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
			.PollingIntervalMS      = 0xFF
		},

155
	.CDC1_DCI_Interface =
156
157
158
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

159
			.InterfaceNumber        = INTERFACE_ID_CDC1_DCI,
160
			.AlternateSetting       = 0,
161

162
			.TotalEndpoints         = 2,
163

164
165
166
			.Class                  = CDC_CSCP_CDCDataClass,
			.SubClass               = CDC_CSCP_NoDataSubclass,
			.Protocol               = CDC_CSCP_NoDataProtocol,
167

168
169
170
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

171
	.CDC1_DataOutEndpoint =
172
173
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
174

175
			.EndpointAddress        = CDC1_RX_EPADDR,
176
177
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_TXRX_EPSIZE,
178
			.PollingIntervalMS      = 0x05
179
		},
180
181

	.CDC1_DataInEndpoint =
182
183
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
184

185
			.EndpointAddress        = CDC1_TX_EPADDR,
186
187
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_TXRX_EPSIZE,
188
			.PollingIntervalMS      = 0x05
189
190
		},

191
	.CDC2_IAD =
192
193
194
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},

195
			.FirstInterfaceIndex    = INTERFACE_ID_CDC2_CCI,
196
197
			.TotalInterfaces        = 2,

198
199
200
			.Class                  = CDC_CSCP_CDCClass,
			.SubClass               = CDC_CSCP_ACMSubclass,
			.Protocol               = CDC_CSCP_ATCommandProtocol,
201
202
203
204

			.IADStrIndex            = NO_DESCRIPTOR
		},

205
	.CDC2_CCI_Interface =
206
207
208
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

209
			.InterfaceNumber        = INTERFACE_ID_CDC2_CCI,
210
			.AlternateSetting       = 0,
211

212
			.TotalEndpoints         = 1,
213

214
215
216
			.Class                  = CDC_CSCP_CDCClass,
			.SubClass               = CDC_CSCP_ACMSubclass,
			.Protocol               = CDC_CSCP_ATCommandProtocol,
217

218
219
220
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

221
	.CDC2_Functional_Header =
222
		{
223
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = CDC_DTYPE_CSInterface},
224
			.Subtype                = CDC_DSUBTYPE_CSInterface_Header,
225

226
			.CDCSpecification       = VERSION_BCD(1,1,0),
227
228
		},

229
	.CDC2_Functional_ACM =
230
		{
231
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = CDC_DTYPE_CSInterface},
232
			.Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
233

234
			.Capabilities           = 0x06,
235
		},
236
237

	.CDC2_Functional_Union =
238
		{
239
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = CDC_DTYPE_CSInterface},
240
			.Subtype                = CDC_DSUBTYPE_CSInterface_Union,
241

242
243
			.MasterInterfaceNumber  = INTERFACE_ID_CDC2_CCI,
			.SlaveInterfaceNumber   = INTERFACE_ID_CDC2_DCI,
244
245
		},

246
	.CDC2_ManagementEndpoint =
247
248
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
249

250
			.EndpointAddress        = CDC2_NOTIFICATION_EPADDR,
251
252
253
254
255
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
			.PollingIntervalMS      = 0xFF
		},

256
	.CDC2_DCI_Interface =
257
258
259
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

260
			.InterfaceNumber        = INTERFACE_ID_CDC2_DCI,
261
			.AlternateSetting       = 0,
262

263
			.TotalEndpoints         = 2,
264

265
266
267
			.Class                  = CDC_CSCP_CDCDataClass,
			.SubClass               = CDC_CSCP_NoDataSubclass,
			.Protocol               = CDC_CSCP_NoDataProtocol,
268

269
270
271
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

272
	.CDC2_DataOutEndpoint =
273
274
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
275

276
			.EndpointAddress        = CDC2_RX_EPADDR,
277
278
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_TXRX_EPSIZE,
279
			.PollingIntervalMS      = 0x05
280
		},
281
282

	.CDC2_DataInEndpoint =
283
284
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
285

286
			.EndpointAddress        = CDC2_TX_EPADDR,
287
288
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_TXRX_EPSIZE,
289
			.PollingIntervalMS      = 0x05
290
291
292
293
294
295
296
		}
};

/** 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.
 */
297
const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
298
299
300
301
302

/** 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.
 */
303
const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"LUFA Library");
304
305
306
307
308

/** 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.
 */
309
const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA Dual CDC Demo");
310
311
312
313
314
315
316

/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 *  USB host.
 */
317
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
318
                                    const uint16_t wIndex,
319
                                    const void** const DescriptorAddress)
320
321
322
323
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

324
325
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
326
327
328
329

	switch (DescriptorType)
	{
		case DTYPE_Device:
330
			Address = &DeviceDescriptor;
331
332
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
333
		case DTYPE_Configuration:
334
			Address = &ConfigurationDescriptor;
335
336
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
337
		case DTYPE_String:
338
339
			switch (DescriptorNumber)
			{
340
				case STRING_ID_Language:
341
					Address = &LanguageString;
342
343
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
344
				case STRING_ID_Manufacturer:
345
					Address = &ManufacturerString;
346
347
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
348
				case STRING_ID_Product:
349
					Address = &ProductString;
350
351
352
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
353

354
355
			break;
	}
356

357
358
359
	*DescriptorAddress = Address;
	return Size;
}
360