Descriptors.c 9.02 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
40
41
42
43
44
45
46
/*
             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"

/** 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 =
{
47
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
48
		
49
50
51
52
	.USBSpecification       = VERSION_BCD(01.10),
	.Class                  = 0x02,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
53
				
54
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
55
		
56
57
58
	.VendorID               = 0x03EB,
	.ProductID              = 0x2044,
	.ReleaseNumber          = 0x0000,
59
		
60
61
62
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
63
		
64
	.NumberOfConfigurations = 1
65
66
67
68
69
70
71
72
73
};

/** 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 =
{
74
	.Config = 
75
		{
76
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
77

78
79
			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 2,
80
				
81
82
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
83
				
84
			.ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
85
			
86
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
87
88
		},
		
89
	.CCI_Interface = 
90
		{
91
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
92

93
94
			.InterfaceNumber        = 0,
			.AlternateSetting       = 0,
95
			
96
			.TotalEndpoints         = 1,
97
				
98
99
100
			.Class                  = 0x02,
			.SubClass               = 0x02,
			.Protocol               = 0x01,
101
				
102
			.InterfaceStrIndex      = NO_DESCRIPTOR
103
104
		},

105
	.CDC_Functional_IntHeader = 
106
		{
107
108
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x00,
109
			
110
			.Data                   = {0x01, 0x10}
111
112
		},

113
	.CDC_Functional_CallManagement = 
114
		{
115
116
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x01,
117
			
118
			.Data                   = {0x03, 0x01}
119
120
		},

121
	.CDC_Functional_AbstractControlManagement = 
122
		{
123
124
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
			.SubType                = 0x02,
125
			
126
			.Data                   = {0x06}
127
128
		},
		
129
	.CDC_Functional_Union = 
130
		{
131
132
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x06,
133
			
134
			.Data                   = {0x00, 0x01}
135
136
		},

137
	.ManagementEndpoint = 
138
		{
139
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
140
										 
141
142
143
144
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
			.Attributes             = EP_TYPE_INTERRUPT,
			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
			.PollingIntervalMS      = 0xFF
145
146
		},

147
	.DCI_Interface = 
148
		{
149
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
150

151
152
			.InterfaceNumber        = 1,
			.AlternateSetting       = 0,
153
			
154
			.TotalEndpoints         = 2,
155
				
156
157
158
			.Class                  = 0x0A,
			.SubClass               = 0x00,
			.Protocol               = 0x00,
159
				
160
			.InterfaceStrIndex      = NO_DESCRIPTOR
161
162
		},

163
	.DataOutEndpoint = 
164
		{
165
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
166
										 
167
168
169
170
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
			.Attributes             = EP_TYPE_BULK,
			.EndpointSize           = CDC_TXRX_EPSIZE,
			.PollingIntervalMS      = 0x00
171
172
		},
		
173
	.DataInEndpoint = 
174
		{
175
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
176
										 
177
178
179
180
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
			.Attributes             = EP_TYPE_BULK,
			.EndpointSize           = CDC_TXRX_EPSIZE,
			.PollingIntervalMS      = 0x00
181
182
183
184
185
186
187
188
189
		}
};

/** 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 =
{
190
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
191
		
192
	.UnicodeString          = {LANGUAGE_ID_ENG}
193
194
195
196
197
198
199
200
};

/** 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 =
{
201
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
202
		
203
	.UnicodeString          = L"Dean Camera"
204
205
206
207
208
209
210
211
};

/** 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 =
{
212
	.Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},
213
		
214
	.UnicodeString          = L"LUFA CDC Demo"
215
216
};

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

228
229
	void*          Address = NULL;
	uint16_t       Size    = NO_DESCRIPTOR;
230
231
232
233

	switch (DescriptorType)
	{
		case DTYPE_Device:
234
			Address = (void*)&DeviceDescriptor;
235
236
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
237
		case DTYPE_Configuration: 
238
			Address = (void*)&ConfigurationDescriptor;
239
240
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
241
		case DTYPE_String: 
242
243
			switch (DescriptorNumber)
			{
244
				case 0x00: 
245
					Address = (void*)&LanguageString;
246
247
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
248
				case 0x01: 
249
					Address = (void*)&ManufacturerString;
250
251
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
252
				case 0x02: 
253
					Address = (void*)&ProductString;
254
255
256
257
258
259
260
261
262
263
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
			
			break;
	}
	
	*DescriptorAddress = Address;		
	return Size;
}