Descriptors.c 10.6 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(02.00),
	.Class                  = 0x00,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
53
				
54
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
55
		
56
57
58
	.VendorID               = 0x03EB,
	.ProductID              = 0x2047,
	.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
	.AudioControlInterface = 
90
		{
91
			.Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
92

93
94
			.InterfaceNumber          = 0,
			.AlternateSetting         = 0,
95
			
96
			.TotalEndpoints           = 0,
97
				
98
99
100
			.Class                    = 0x01,
			.SubClass                 = 0x01,
			.Protocol                 = 0x00,
101
				
102
			.InterfaceStrIndex        = NO_DESCRIPTOR			
103
104
		},
	
105
	.AudioControlInterface_SPC = 
106
		{
107
108
			.Header                   = {.Size = sizeof(USB_AudioInterface_AC_t), .Type = DTYPE_AudioInterface},
			.Subtype                  = DSUBTYPE_Header,
109
			
110
111
112
113
			.ACSpecification          = VERSION_BCD(01.00),
			.TotalLength              = (sizeof(USB_AudioInterface_AC_t) +
			                             sizeof(USB_AudioInputTerminal_t) +
									     sizeof(USB_AudioOutputTerminal_t)),
114
			
115
116
			.InCollection             = 1,
			.InterfaceNumbers         = {1},			
117
118
		},

119
	.InputTerminal = 
120
		{
121
122
			.Header                   = {.Size = sizeof(USB_AudioInputTerminal_t), .Type = DTYPE_AudioInterface},
			.Subtype                  = DSUBTYPE_InputTerminal,
123
		
124
125
126
			.TerminalID               = 0x01,
			.TerminalType             = TERMINAL_IN_MIC,
			.AssociatedOutputTerminal = 0x00,
127
			
128
129
			.TotalChannels            = 1,
			.ChannelConfig            = 0,
130
			
131
132
			.ChannelStrIndex          = NO_DESCRIPTOR,
			.TerminalStrIndex         = NO_DESCRIPTOR
133
134
		},

135
	.OutputTerminal = 
136
		{
137
138
			.Header                   = {.Size = sizeof(USB_AudioOutputTerminal_t), .Type = DTYPE_AudioInterface},
			.Subtype                  = DSUBTYPE_OutputTerminal,
139
		
140
141
142
			.TerminalID               = 0x02,
			.TerminalType             = TERMINAL_STREAMING,
			.AssociatedInputTerminal  = 0x00,
143
			
144
			.SourceID                 = 0x01,
145
			
146
			.TerminalStrIndex         = NO_DESCRIPTOR			
147
148
		},

149
	.AudioStreamInterface_Alt0 = 
150
		{
151
			.Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
152

153
154
			.InterfaceNumber          = 1,
			.AlternateSetting         = 0,
155
			
156
			.TotalEndpoints           = 0,
157
				
158
159
160
			.Class                    = 0x01,
			.SubClass                 = 0x02,
			.Protocol                 = 0x00,
161
				
162
			.InterfaceStrIndex        = NO_DESCRIPTOR
163
164
		},

165
	.AudioStreamInterface_Alt1 = 
166
		{
167
			.Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
168

169
170
			.InterfaceNumber          = 1,
			.AlternateSetting         = 1,
171
			
172
			.TotalEndpoints           = 1,
173
				
174
175
176
			.Class                    = 0x01,
			.SubClass                 = 0x02,
			.Protocol                 = 0x00,
177
				
178
			.InterfaceStrIndex        = NO_DESCRIPTOR
179
180
		},
		
181
	.AudioStreamInterface_SPC = 
182
		{
183
184
			.Header                   = {.Size = sizeof(USB_AudioInterface_AS_t), .Type = DTYPE_AudioInterface},
			.Subtype                  = DSUBTYPE_General,
185
			
186
			.TerminalLink             = 0x02,
187
			
188
189
			.FrameDelay               = 1,
			.AudioFormat              = 0x0001
190
191
		},
		
192
	.AudioFormat = 
193
		{
194
195
			.Header                   = {.Size = sizeof(USB_AudioFormat_t), .Type = DTYPE_AudioInterface},
			.Subtype                  = DSUBTYPE_Format,
196

197
198
			.FormatType               = 0x01,
			.Channels                 = 0x01,
199
			
200
201
202
			.SubFrameSize             = 0x02,
			.BitResolution            = 16,
			.SampleFrequencyType      = (sizeof(ConfigurationDescriptor.AudioFormat.SampleFrequencies) / sizeof(AudioSampleFreq_t)),
203
		
204
			.SampleFrequencies        = {SAMPLE_FREQ(AUDIO_SAMPLE_FREQUENCY)}
205
206
		},
	
207
	.AudioEndpoint = 
208
		{
209
			.Endpoint = 
210
				{
211
					.Header              = {.Size = sizeof(USB_AudioStreamEndpoint_Std_t), .Type = DTYPE_Endpoint},
212

213
214
215
216
					.EndpointAddress     = (ENDPOINT_DESCRIPTOR_DIR_IN | AUDIO_STREAM_EPNUM),
					.Attributes          = (EP_TYPE_ISOCHRONOUS | ENDPOINT_ATTR_SYNC | ENDPOINT_USAGE_DATA),
					.EndpointSize        = AUDIO_STREAM_EPSIZE,
					.PollingIntervalMS   = 1
217
218
				},
			
219
220
			.Refresh                  = 0,
			.SyncEndpointNumber       = 0
221
222
		},
		
223
	.AudioEndpoint_SPC = 
224
		{
225
226
			.Header                   = {.Size = sizeof(USB_AudioStreamEndpoint_Spc_t), .Type = DTYPE_AudioEndpoint},
			.Subtype                  = DSUBTYPE_General,
227
			
228
			.Attributes               = 0x00,
229
			
230
231
			.LockDelayUnits           = 0x00,
			.LockDelay                = 0x0000
232
233
234
235
236
237
238
239
240
		}
};

/** 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 =
{
241
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
242
		
243
	.UnicodeString          = {LANGUAGE_ID_ENG}
244
245
246
247
248
249
250
251
};

/** 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 =
{
252
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
253
		
254
	.UnicodeString          = L"Dean Camera"
255
256
257
258
259
260
261
262
};

/** 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 =
{
263
	.Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
264
		
265
	.UnicodeString          = L"LUFA Audio In Demo"
266
267
};

268
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
269
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
270
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
271
272
273
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 *  USB host.
 */
274
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
275
276
277
278
279
280
281
282
283
284
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

	void*    Address = NULL;
	uint16_t Size    = NO_DESCRIPTOR;

	switch (DescriptorType)
	{
		case DTYPE_Device:
285
			Address = (void*)&DeviceDescriptor;
286
287
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
288
		case DTYPE_Configuration: 
289
			Address = (void*)&ConfigurationDescriptor;
290
291
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
292
		case DTYPE_String: 
293
294
			switch (DescriptorNumber)
			{
295
				case 0x00: 
296
					Address = (void*)&LanguageString;
297
298
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
299
				case 0x01: 
300
					Address = (void*)&ManufacturerString;
301
302
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
303
				case 0x02: 
304
					Address = (void*)&ProductString;
305
306
307
308
309
310
311
312
313
314
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
			
			break;
	}
	
	*DescriptorAddress = Address;
	return Size;
}