Blame view

lufa-master/Projects/Webserver/Descriptors.c 12.6 KB
142ecdaf   rguillom   first commit
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
  /*
               LUFA Library
       Copyright (C) Dean Camera, 2019.
  
    dean [at] fourwalledcubicle [dot] com
             www.lufa-lib.org
  */
  
  /*
    Copyright 2019  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  
    Permission to use, copy, modify, distribute, and sell this
    software and its documentation for any purpose is hereby granted
    without fee, 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 disclaims 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"
  
  
  /** 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.
   */
  const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  {
  	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  
  	.USBSpecification       = VERSION_BCD(2,0,0),
  	.Class                  = USB_CSCP_IADDeviceClass,
  	.SubClass               = USB_CSCP_IADDeviceSubclass,
  	.Protocol               = USB_CSCP_IADDeviceProtocol,
  
  	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  
  	.VendorID               = 0x03EB,
  	.ProductID              = 0x2069,
  	.ReleaseNumber          = VERSION_BCD(0,0,2),
  
  	.ManufacturerStrIndex   = STRING_ID_Manufacturer,
  	.ProductStrIndex        = STRING_ID_Product,
  	.SerialNumStrIndex      = USE_INTERNAL_SERIAL,
  
  	.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.
   */
  const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  {
  	.Config =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  
  			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  			.TotalInterfaces        = 3,
  
  			.ConfigurationNumber    = 1,
  			.ConfigurationStrIndex  = NO_DESCRIPTOR,
  
  			.ConfigAttributes       = USB_CONFIG_ATTR_RESERVED,
  
  			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  		},
  
  	.CDC_IAD =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},
  
  			.FirstInterfaceIndex    = INTERFACE_ID_CDC_CCI,
  			.TotalInterfaces        = 2,
  
  			.Class                  = CDC_CSCP_CDCClass,
  			.SubClass               = CDC_CSCP_ACMSubclass,
  			.Protocol               = CDC_CSCP_VendorSpecificProtocol,
  
  			.IADStrIndex            = NO_DESCRIPTOR
  		},
  
  	.CDC_CCI_Interface =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  
  			.InterfaceNumber        = INTERFACE_ID_CDC_CCI,
  			.AlternateSetting       = 0,
  
  			.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 = CDC_DTYPE_CSInterface},
  			.Subtype                = CDC_DSUBTYPE_CSInterface_Header,
  
  			.CDCSpecification       = VERSION_BCD(1,1,0),
  		},
  
  	.CDC_Functional_ACM =
  		{
  			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = CDC_DTYPE_CSInterface},
  			.Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
  
  			.Capabilities           = 0x00,
  		},
  
  	.CDC_Functional_Union =
  		{
  			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = CDC_DTYPE_CSInterface},
  			.Subtype                = CDC_DSUBTYPE_CSInterface_Union,
  
  			.MasterInterfaceNumber  = INTERFACE_ID_CDC_CCI,
  			.SlaveInterfaceNumber   = INTERFACE_ID_CDC_DCI,
  		},
  
  	.CDC_NotificationEndpoint =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  
  			.EndpointAddress        = CDC_NOTIFICATION_EPADDR,
  			.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},
  
  			.InterfaceNumber        = INTERFACE_ID_CDC_DCI,
  			.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},
  
  			.EndpointAddress        = CDC_RX_EPADDR,
  			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  			.EndpointSize           = CDC_TXRX_EPSIZE,
  			.PollingIntervalMS      = 0x05
  		},
  
  	.RNDIS_DataInEndpoint =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  
  			.EndpointAddress        = CDC_TX_EPADDR,
  			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  			.EndpointSize           = CDC_TXRX_EPSIZE,
  			.PollingIntervalMS      = 0x05
  		},
  
  	.MS_Interface =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  
  			.InterfaceNumber        = INTERFACE_ID_MassStorage,
  			.AlternateSetting       = 0,
  
  			.TotalEndpoints         = 2,
  
  			.Class                  = MS_CSCP_MassStorageClass,
  			.SubClass               = MS_CSCP_SCSITransparentSubclass,
  			.Protocol               = MS_CSCP_BulkOnlyTransportProtocol,
  
  			.InterfaceStrIndex      = NO_DESCRIPTOR
  		},
  
  	.MS_DataInEndpoint =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  
  			.EndpointAddress        = MASS_STORAGE_IN_EPADDR,
  			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  			.EndpointSize           = MASS_STORAGE_IO_EPSIZE,
  			.PollingIntervalMS      = 0x05
  		},
  
  	.MS_DataOutEndpoint =
  		{
  			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
  
  			.EndpointAddress        = MASS_STORAGE_OUT_EPADDR,
  			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  			.EndpointSize           = MASS_STORAGE_IO_EPSIZE,
  			.PollingIntervalMS      = 0x05
  		}
  };
  
  /** 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.
   */
  const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
  
  /** 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.
   */
  const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"LUFA Library");
  
  /** 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.
   */
  const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA Webserver");
  
  /** 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 },
  	};
  
  /** 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.
   */
  uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                      const uint16_t wIndex,
                                      const void** const DescriptorAddress)
  {
  	const uint8_t  DescriptorType   = (wValue >> 8);
  	const uint8_t  DescriptorNumber = (wValue & 0xFF);
  
  	const void* Address = NULL;
  	uint16_t    Size    = NO_DESCRIPTOR;
  
  	switch (DescriptorType)
  	{
  		case DTYPE_Device:
  			Address = &DeviceDescriptor;
  			Size    = sizeof(USB_Descriptor_Device_t);
  			break;
  		case DTYPE_Configuration:
  			Address = &ConfigurationDescriptor;
  			Size    = sizeof(USB_Descriptor_Configuration_t);
  			break;
  		case DTYPE_String:
  			switch (DescriptorNumber)
  			{
  				case STRING_ID_Language:
  					Address = &LanguageString;
  					Size    = pgm_read_byte(&LanguageString.Header.Size);
  					break;
  				case STRING_ID_Manufacturer:
  					Address = &ManufacturerString;
  					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
  					break;
  				case STRING_ID_Product:
  					Address = &ProductString;
  					Size    = pgm_read_byte(&ProductString.Header.Size);
  					break;
  				case STRING_ID_MS_Compat:
  					Address = &MSConpatibilityString;
  					Size    = pgm_read_byte(&MSConpatibilityString.Header.Size);
  					break;
  			}
  
  			break;
  	}
  
  	*DescriptorAddress = Address;
  	return Size;
  }
  
  /** 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();
  		}
  	}
  }