Descriptors.c 10.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

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

12
13
14
15
16
17
18
  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 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
  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                  = 0x02,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
65
				
66
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
67
		
68
69
70
	.VendorID               = 0x03EB,
	.ProductID              = 0x2044,
	.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        = 2,
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
	.CCI_Interface = 
102
		{
103
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
104

105
106
			.InterfaceNumber        = 0,
			.AlternateSetting       = 0,
107
			
108
			.TotalEndpoints         = 1,
109
				
110
111
112
			.Class                  = 0x02,
			.SubClass               = 0x02,
			.Protocol               = 0x01,
113
				
114
			.InterfaceStrIndex      = NO_DESCRIPTOR
115
116
		},

117
	.CDC_Functional_IntHeader = 
118
		{
119
120
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x00,
121
			
122
			.Data                   = {0x01, 0x10}
123
124
		},

125
	.CDC_Functional_CallManagement = 
126
		{
127
128
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x01,
129
			
130
			.Data                   = {0x03, 0x01}
131
132
		},

133
	.CDC_Functional_AbstractControlManagement = 
134
		{
135
136
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
			.SubType                = 0x02,
137
			
138
			.Data                   = {0x06}
139
140
		},
		
141
	.CDC_Functional_Union = 
142
		{
143
144
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x06,
145
			
146
			.Data                   = {0x00, 0x01}
147
148
		},

149
	.ManagementEndpoint = 
150
		{
151
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
152
										 
153
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
154
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
155
156
			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
			.PollingIntervalMS      = 0xFF
157
158
		},

159
	.DCI_Interface = 
160
		{
161
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
162

163
164
			.InterfaceNumber        = 1,
			.AlternateSetting       = 0,
165
			
166
			.TotalEndpoints         = 2,
167
				
168
169
170
			.Class                  = 0x0A,
			.SubClass               = 0x00,
			.Protocol               = 0x00,
171
				
172
			.InterfaceStrIndex      = NO_DESCRIPTOR
173
174
		},

175
	.DataOutEndpoint = 
176
		{
177
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
178
										 
179
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
180
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
181
182
			.EndpointSize           = CDC_TXRX_EPSIZE,
			.PollingIntervalMS      = 0x00
183
184
		},
		
185
	.DataInEndpoint = 
186
		{
187
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
188
										 
189
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
190
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
191
192
			.EndpointSize           = CDC_TXRX_EPSIZE,
			.PollingIntervalMS      = 0x00
193
194
195
196
197
198
199
200
201
		}
};

/** 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 =
{
202
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
203
		
204
	.UnicodeString          = {LANGUAGE_ID_ENG}
205
206
207
208
209
210
211
212
};

/** 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 =
{
213
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
214
		
215
	.UnicodeString          = L"Dean Camera"
216
217
218
219
220
221
222
223
};

/** 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 =
{
224
	.Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},
225
		
226
	.UnicodeString          = L"LUFA CDC Demo"
227
228
};

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

240
241
	void*          Address = NULL;
	uint16_t       Size    = NO_DESCRIPTOR;
242
243
244
245

	switch (DescriptorType)
	{
		case DTYPE_Device:
246
			Address = (void*)&DeviceDescriptor;
247
248
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
249
		case DTYPE_Configuration: 
250
			Address = (void*)&ConfigurationDescriptor;
251
252
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
253
		case DTYPE_String: 
254
255
			switch (DescriptorNumber)
			{
256
				case 0x00: 
257
					Address = (void*)&LanguageString;
258
259
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
260
				case 0x01: 
261
					Address = (void*)&ManufacturerString;
262
263
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
264
				case 0x02: 
265
					Address = (void*)&ProductString;
266
267
268
269
270
271
272
273
274
275
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
			
			break;
	}
	
	*DescriptorAddress = Address;		
	return Size;
}