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
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
/*
             LUFA Library
     Copyright (C) Dean Camera, 2010.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2010  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 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 =
{
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
		
	.USBSpecification       = VERSION_BCD(02.00),
	.Class                  = 0x00,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
				
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
		
	.VendorID               = 0x03EB,
	.ProductID              = 0x2046,
	.ReleaseNumber          = 0x0000,
		
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
		
	.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.
 */
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          = 2,

			.ConfigurationNumber      = 1,
			.ConfigurationStrIndex    = NO_DESCRIPTOR,
				
			.ConfigAttributes         = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
			
			.MaxPowerConsumption      = USB_CONFIG_POWER_MA(100)
		},
		
	.Audio_ControlInterface = 
		{
			.Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber          = 0,
			.AlternateSetting         = 0,
			
			.TotalEndpoints           = 0,
				
			.Class                    = 0x01,
			.SubClass                 = 0x01,
			.Protocol                 = 0x00,
				
			.InterfaceStrIndex        = NO_DESCRIPTOR
		},
	
	.Audio_ControlInterface_SPC = 
		{
107
108
			.Header                   = {.Size = sizeof(USB_Audio_Interface_AC_t), .Type = DTYPE_CSInterface},
			.Subtype                  = DSUBTYPE_AudioHeader,
109
110
111
112
113
114
115
116
117
118
119
120
			
			.ACSpecification          = VERSION_BCD(01.00),
			.TotalLength              = (sizeof(USB_Audio_Interface_AC_t) +
			                             sizeof(USB_Audio_InputTerminal_t) +
			                             sizeof(USB_Audio_OutputTerminal_t)),
			
			.InCollection             = 1,
			.InterfaceNumbers         = {1},
		},

	.Audio_InputTerminal = 
		{
121
			.Header                   = {.Size = sizeof(USB_Audio_InputTerminal_t), .Type = DTYPE_CSInterface},
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
			.Subtype                  = DSUBTYPE_InputTerminal,
		
			.TerminalID               = 0x01,
			.TerminalType             = TERMINAL_STREAMING,
			.AssociatedOutputTerminal = 0x00,
			
			.TotalChannels            = 2,
			.ChannelConfig            = (CHANNEL_LEFT_FRONT | CHANNEL_RIGHT_FRONT),
			
			.ChannelStrIndex          = NO_DESCRIPTOR,
			.TerminalStrIndex         = NO_DESCRIPTOR
		},

	.Audio_OutputTerminal = 
		{
137
			.Header                   = {.Size = sizeof(USB_Audio_OutputTerminal_t), .Type = DTYPE_CSInterface},
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
			.Subtype                  = DSUBTYPE_OutputTerminal,
		
			.TerminalID               = 0x02,
			.TerminalType             = TERMINAL_OUT_SPEAKER,
			.AssociatedInputTerminal  = 0x00,
			
			.SourceID                 = 0x01,
			
			.TerminalStrIndex         = NO_DESCRIPTOR			
		},

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

			.InterfaceNumber          = 1,
			.AlternateSetting         = 0,
			
			.TotalEndpoints           = 0,
				
			.Class                    = 0x01,
			.SubClass                 = 0x02,
			.Protocol                 = 0x00,
				
			.InterfaceStrIndex        = NO_DESCRIPTOR
		},

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

			.InterfaceNumber          = 1,
			.AlternateSetting         = 1,
			
			.TotalEndpoints           = 1,
				
			.Class                    = 0x01,
			.SubClass                 = 0x02,
			.Protocol                 = 0x00,
				
			.InterfaceStrIndex        = NO_DESCRIPTOR
		},
		
	.Audio_StreamInterface_SPC = 
		{
183
			.Header                   = {.Size = sizeof(USB_Audio_Interface_AS_t), .Type = DTYPE_CSInterface},
184
185
186
187
188
189
190
191
192
193
			.Subtype                  = DSUBTYPE_General,
			
			.TerminalLink             = 0x01,
			
			.FrameDelay               = 1,
			.AudioFormat              = 0x0001
		},
		
	.Audio_AudioFormat = 
		{
194
			.Header                   = {.Size = sizeof(USB_Audio_Format_t), .Type = DTYPE_CSInterface},
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
			.Subtype                  = DSUBTYPE_Format,

			.FormatType               = 0x01,
			.Channels                 = 0x02,
			
			.SubFrameSize             = 0x02,
			.BitResolution            = 16,

			.SampleFrequencyType      = (sizeof(ConfigurationDescriptor.Audio_AudioFormat.SampleFrequencies) /
			                             sizeof(Audio_SampleFreq_t)),		
			.SampleFrequencies        = {SAMPLE_FREQ(AUDIO_SAMPLE_FREQUENCY)}
		},
	
	.Audio_StreamEndpoint = 
		{
			.Endpoint = 
				{
					.Header              = {.Size = sizeof(USB_Audio_StreamEndpoint_Std_t), .Type = DTYPE_Endpoint},

					.EndpointAddress     = (ENDPOINT_DESCRIPTOR_DIR_OUT | AUDIO_STREAM_EPNUM),
					.Attributes          = (EP_TYPE_ISOCHRONOUS | ENDPOINT_ATTR_SYNC | ENDPOINT_USAGE_DATA),
					.EndpointSize        = AUDIO_STREAM_EPSIZE,
					.PollingIntervalMS   = 1
				},
			
			.Refresh                  = 0,
			.SyncEndpointNumber       = 0
		},
		
	.Audio_StreamEndpoint_SPC = 
		{
226
			.Header                   = {.Size = sizeof(USB_Audio_StreamEndpoint_Spc_t), .Type = DTYPE_CSEndpoint},
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
			.Subtype                  = DSUBTYPE_General,
			
			.Attributes               = EP_ACCEPTS_SMALL_PACKETS,
			
			.LockDelayUnits           = 0x00,
			.LockDelay                = 0x0000
		}
};

/** 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 =
{
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
		
	.UnicodeString          = {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.
 */
USB_Descriptor_String_t PROGMEM ManufacturerString =
{
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
		
	.UnicodeString          = L"Dean Camera"
};

/** 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 =
{
	.Header                 = {.Size = USB_STRING_LEN(19), .Type = DTYPE_String},
		
	.UnicodeString          = L"LUFA Audio Out Demo"
};

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

282
283
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
284
285
286
287

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