Descriptors.c 12.6 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(2,0,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
	.VendorID               = 0x03EB,
58
	.ProductID              = 0x2069,
59
	.ReleaseNumber          = VERSION_BCD(0,0,2),
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
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
80
			.TotalInterfaces        = 3,
81

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

85
			.ConfigAttributes       = USB_CONFIG_ATTR_RESERVED,
86

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

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

94
			.FirstInterfaceIndex    = INTERFACE_ID_CDC_CCI,
95
96
97
98
99
100
101
102
103
104
			.TotalInterfaces        = 2,

			.Class                  = CDC_CSCP_CDCClass,
			.SubClass               = CDC_CSCP_ACMSubclass,
			.Protocol               = CDC_CSCP_VendorSpecificProtocol,

			.IADStrIndex            = NO_DESCRIPTOR
		},

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

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

111
112
113
114
115
116
117
118
119
120
121
122
123
124
			.TotalEndpoints         = 1,

			.Class                  = CDC_CSCP_CDCClass,
			.SubClass               = CDC_CSCP_ACMSubclass,
			.Protocol               = CDC_CSCP_VendorSpecificProtocol,

			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

	.CDC_Functional_Header =
		{
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
			.Subtype                = CDC_DSUBTYPE_CSInterface_Header,

125
			.CDCSpecification       = VERSION_BCD(1,1,0),
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
		},

	.CDC_Functional_ACM =
		{
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
			.Subtype                = CDC_DSUBTYPE_CSInterface_ACM,

			.Capabilities           = 0x00,
		},

	.CDC_Functional_Union =
		{
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
			.Subtype                = CDC_DSUBTYPE_CSInterface_Union,

141
142
			.MasterInterfaceNumber  = INTERFACE_ID_CDC_CCI,
			.SlaveInterfaceNumber   = INTERFACE_ID_CDC_DCI,
143
144
145
146
147
148
		},

	.CDC_NotificationEndpoint =
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

149
			.EndpointAddress        = CDC_NOTIFICATION_EPADDR,
150
151
152
153
154
155
156
157
158
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
			.PollingIntervalMS      = 0xFF
		},

	.CDC_DCI_Interface =
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

159
			.InterfaceNumber        = INTERFACE_ID_CDC_DCI,
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
			.AlternateSetting       = 0,

			.TotalEndpoints         = 2,

			.Class                  = CDC_CSCP_CDCDataClass,
			.SubClass               = CDC_CSCP_NoDataSubclass,
			.Protocol               = CDC_CSCP_NoDataProtocol,

			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

	.RNDIS_DataOutEndpoint =
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

175
			.EndpointAddress        = CDC_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
182
183
184
		},

	.RNDIS_DataInEndpoint =
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

185
			.EndpointAddress        = CDC_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
192
193
194
		},

	.MS_Interface =
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

195
			.InterfaceNumber        = INTERFACE_ID_MassStorage,
196
197
			.AlternateSetting       = 0,

198
			.TotalEndpoints         = 2,
199

200
201
202
			.Class                  = MS_CSCP_MassStorageClass,
			.SubClass               = MS_CSCP_SCSITransparentSubclass,
			.Protocol               = MS_CSCP_BulkOnlyTransportProtocol,
203

204
205
206
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

207
	.MS_DataInEndpoint =
208
209
210
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

211
			.EndpointAddress        = MASS_STORAGE_IN_EPADDR,
212
213
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = MASS_STORAGE_IO_EPSIZE,
214
			.PollingIntervalMS      = 0x05
215
216
		},

217
	.MS_DataOutEndpoint =
218
219
220
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

221
			.EndpointAddress        = MASS_STORAGE_OUT_EPADDR,
222
223
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = MASS_STORAGE_IO_EPSIZE,
224
			.PollingIntervalMS      = 0x05
225
226
227
228
229
230
231
		}
};

/** 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.
 */
232
const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
233
234
235
236
237

/** 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.
 */
238
const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"Dean Camera");
239
240
241
242
243

/** 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.
 */
244
const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA Webserver");
245

246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/** Microsoft OS Compatibility string descriptor. This is a special string descriptor that Microsoft based OS hosts
 *  will query at string descriptor ID 0xEE on initial enumeration, to test if the device supports the Microsoft OS
 *  Compatibility descriptor extensions (used to give the host additional information on the device's general class
 *  compatibility for driver-less installation).
 */
const USB_Descriptor_String_t PROGMEM MSConpatibilityString = USB_STRING_DESCRIPTOR_ARRAY('M','S','F','T','1','0','0', VENDOR_REQUEST_ID_MS_COMPAT);

/** Microsoft OS Compatibility 1.0 descriptor. This is a special descriptor returned by the device on vendor request
 *  from the host, giving the OS additional compatibility information. This allows the host to automatically install
 *  the appropriate driver for various devices which share a common USB class (in this case RNDIS, which uses the
 *  CDC-ACM class usually used by virtual to serial adapters).
 */
const USB_Descriptor_MSCompatibility_t PROGMEM MSCompatibilityDescriptor =
	{
		.dwLength                   = sizeof(USB_Descriptor_MSCompatibility_t),
		.bcdVersion                 = VERSION_BCD(1,0,0),
		.wIndex                     = 4,
		.bCount                     = 1,
		.bReserved                  = { 0 },
		.bFirstInterfaceNumber      = INTERFACE_ID_CDC_CCI,
		.bReserved2                 = 1, // Must always be 1 according to spec
		.compatibleID               = "RNDIS",
		.subCompatibleID            = "5162001",
		.bReserved3                 = { 0 },
	};

272
273
274
275
276
277
/** 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.
 */
278
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
279
                                    const uint16_t wIndex,
280
                                    const void** const DescriptorAddress)
281
282
283
284
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

285
286
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
287
288
289

	switch (DescriptorType)
	{
290
		case DTYPE_Device:
291
			Address = &DeviceDescriptor;
292
293
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
294
		case DTYPE_Configuration:
295
			Address = &ConfigurationDescriptor;
296
297
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
298
		case DTYPE_String:
299
300
			switch (DescriptorNumber)
			{
301
				case STRING_ID_Language:
302
					Address = &LanguageString;
303
304
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
305
				case STRING_ID_Manufacturer:
306
					Address = &ManufacturerString;
307
308
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
309
				case STRING_ID_Product:
310
					Address = &ProductString;
311
312
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
313
314
315
316
				case STRING_ID_MS_Compat:
					Address = &MSConpatibilityString;
					Size    = pgm_read_byte(&MSConpatibilityString.Header.Size);
					break;
317
			}
318

319
320
			break;
	}
321

322
323
324
	*DescriptorAddress = Address;
	return Size;
}
325

326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
/** Sends the special Microsoft OS Compatibility Descriptor to the host PC, if
 *  the host is requesting it.
 */
void CheckIfMSCompatibilityDescriptorRequest(void)
{
	if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_VENDOR | REQREC_DEVICE))
	{
		if (USB_ControlRequest.bRequest == VENDOR_REQUEST_ID_MS_COMPAT)
		{
			Endpoint_ClearSETUP();

			/* Write the OS compatibility descriptor to the control endpoint */
			Endpoint_Write_Control_PStream_LE(&MSCompatibilityDescriptor, sizeof(MSCompatibilityDescriptor));
			Endpoint_ClearOUT();
		}
	}
}