Descriptors.c 11 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2014.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
17
18
  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
  software without specific, written prior permission.

21
  The author disclaims all warranties with regard to this
22
23
24
25
26
27
28
29
30
31
32
  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
 *
33
 *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special
34
 *  computer-readable structures which the host requests upon device enumeration, to determine
35
 *  the device's capabilities and functions.
36
 */
37

38
39
40
41
42
43
44
#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.
 */
45
const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
46
47
{
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
48

49
	.USBSpecification       = VERSION_BCD(1,1,0),
50
51
52
	.Class                  = USB_CSCP_NoDeviceClass,
	.SubClass               = USB_CSCP_NoDeviceSubclass,
	.Protocol               = USB_CSCP_NoDeviceProtocol,
53

54
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
55

56
57
	.VendorID               = 0x03EB,
	.ProductID              = 0x2047,
58
	.ReleaseNumber          = VERSION_BCD(0,0,2),
59

60
61
	.ManufacturerStrIndex   = STRING_ID_Manufacturer,
	.ProductStrIndex        = STRING_ID_Product,
62
	.SerialNumStrIndex      = NO_DESCRIPTOR,
63

64
65
66
67
68
69
70
71
	.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.
 */
72
const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
73
{
74
	.Config =
75
76
77
78
79
80
81
82
		{
			.Header                   = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

			.TotalConfigurationSize   = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces          = 2,

			.ConfigurationNumber      = 1,
			.ConfigurationStrIndex    = NO_DESCRIPTOR,
83

84
			.ConfigAttributes         = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
85

86
87
			.MaxPowerConsumption      = USB_CONFIG_POWER_MA(100)
		},
88
89

	.Audio_ControlInterface =
90
91
92
		{
			.Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

93
			.InterfaceNumber          = INTERFACE_ID_AudioControl,
94
			.AlternateSetting         = 0,
95

96
			.TotalEndpoints           = 0,
97

98
99
100
			.Class                    = AUDIO_CSCP_AudioClass,
			.SubClass                 = AUDIO_CSCP_ControlSubclass,
			.Protocol                 = AUDIO_CSCP_ControlProtocol,
101

102
103
			.InterfaceStrIndex        = NO_DESCRIPTOR
		},
104
105

	.Audio_ControlInterface_SPC =
106
		{
107
108
			.Header                   = {.Size = sizeof(USB_Audio_Descriptor_Interface_AC_t), .Type = DTYPE_CSInterface},
			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_Header,
109

110
			.ACSpecification          = VERSION_BCD(1,0,0),
111
112
113
			.TotalLength              = (sizeof(USB_Audio_Descriptor_Interface_AC_t) +
			                             sizeof(USB_Audio_Descriptor_InputTerminal_t) +
			                             sizeof(USB_Audio_Descriptor_OutputTerminal_t)),
114

115
			.InCollection             = 1,
116
			.InterfaceNumber          = INTERFACE_ID_AudioStream,
117
118
		},

119
	.Audio_InputTerminal =
120
		{
121
122
			.Header                   = {.Size = sizeof(USB_Audio_Descriptor_InputTerminal_t), .Type = DTYPE_CSInterface},
			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_InputTerminal,
123

124
			.TerminalID               = 0x01,
125
			.TerminalType             = AUDIO_TERMINAL_IN_MIC,
126
			.AssociatedOutputTerminal = 0x00,
127

128
129
			.TotalChannels            = 1,
			.ChannelConfig            = 0,
130

131
132
133
134
			.ChannelStrIndex          = NO_DESCRIPTOR,
			.TerminalStrIndex         = NO_DESCRIPTOR
		},

135
	.Audio_OutputTerminal =
136
		{
137
138
			.Header                   = {.Size = sizeof(USB_Audio_Descriptor_OutputTerminal_t), .Type = DTYPE_CSInterface},
			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_OutputTerminal,
139

140
			.TerminalID               = 0x02,
141
			.TerminalType             = AUDIO_TERMINAL_STREAMING,
142
			.AssociatedInputTerminal  = 0x00,
143

144
			.SourceID                 = 0x01,
145

146
147
148
			.TerminalStrIndex         = NO_DESCRIPTOR
		},

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

153
			.InterfaceNumber          = INTERFACE_ID_AudioStream,
154
			.AlternateSetting         = 0,
155

156
			.TotalEndpoints           = 0,
157

158
159
160
			.Class                    = AUDIO_CSCP_AudioClass,
			.SubClass                 = AUDIO_CSCP_AudioStreamingSubclass,
			.Protocol                 = AUDIO_CSCP_StreamingProtocol,
161

162
163
164
			.InterfaceStrIndex        = NO_DESCRIPTOR
		},

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

169
			.InterfaceNumber          = INTERFACE_ID_AudioStream,
170
			.AlternateSetting         = 1,
171

172
			.TotalEndpoints           = 1,
173

174
175
176
			.Class                    = AUDIO_CSCP_AudioClass,
			.SubClass                 = AUDIO_CSCP_AudioStreamingSubclass,
			.Protocol                 = AUDIO_CSCP_StreamingProtocol,
177

178
179
			.InterfaceStrIndex        = NO_DESCRIPTOR
		},
180
181

	.Audio_StreamInterface_SPC =
182
		{
183
184
			.Header                   = {.Size = sizeof(USB_Audio_Descriptor_Interface_AS_t), .Type = DTYPE_CSInterface},
			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_General,
185

186
			.TerminalLink             = 0x02,
187

188
189
190
			.FrameDelay               = 1,
			.AudioFormat              = 0x0001
		},
191
192

	.Audio_AudioFormat =
193
		{
194
195
196
			.Header                   = {.Size = sizeof(USB_Audio_Descriptor_Format_t) +
			                                     sizeof(ConfigurationDescriptor.Audio_AudioFormatSampleRates),
			                             .Type = DTYPE_CSInterface},
197
			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_FormatType,
198
199
200

			.FormatType               = 0x01,
			.Channels                 = 0x01,
201

202
203
			.SubFrameSize             = 0x02,
			.BitResolution            = 16,
204
205

			.TotalDiscreteSampleRates = (sizeof(ConfigurationDescriptor.Audio_AudioFormatSampleRates) / sizeof(USB_Audio_SampleFreq_t)),
206
		},
207

208
209
	.Audio_AudioFormatSampleRates =
		{
210
211
212
213
214
			AUDIO_SAMPLE_FREQ(8000),
			AUDIO_SAMPLE_FREQ(11025),
			AUDIO_SAMPLE_FREQ(22050),
			AUDIO_SAMPLE_FREQ(44100),
			AUDIO_SAMPLE_FREQ(48000),
215
		},
216
217

	.Audio_StreamEndpoint =
218
		{
219
			.Endpoint =
220
				{
221
					.Header              = {.Size = sizeof(USB_Audio_Descriptor_StreamEndpoint_Std_t), .Type = DTYPE_Endpoint},
222

223
					.EndpointAddress     = AUDIO_STREAM_EPADDR,
224
225
					.Attributes          = (EP_TYPE_ISOCHRONOUS | ENDPOINT_ATTR_SYNC | ENDPOINT_USAGE_DATA),
					.EndpointSize        = AUDIO_STREAM_EPSIZE,
226
					.PollingIntervalMS   = 0x01
227
				},
228

229
230
231
			.Refresh                  = 0,
			.SyncEndpointNumber       = 0
		},
232
233

	.Audio_StreamEndpoint_SPC =
234
		{
235
236
			.Header                   = {.Size = sizeof(USB_Audio_Descriptor_StreamEndpoint_Spc_t), .Type = DTYPE_CSEndpoint},
			.Subtype                  = AUDIO_DSUBTYPE_CSEndpoint_General,
237

238
			.Attributes               = (AUDIO_EP_ACCEPTS_SMALL_PACKETS | AUDIO_EP_SAMPLE_FREQ_CONTROL),
239

240
241
242
243
244
245
246
247
248
			.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.
 */
249
const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR(LANGUAGE_ID_ENG);
250
251
252
253
254

/** 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.
 */
255
const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"Dean Camera");
256
257
258
259
260

/** 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.
 */
261
const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA Audio In Demo");
262
263
264
265
266
267
268

/** 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.
 */
269
270
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                    const uint8_t wIndex,
271
                                    const void** const DescriptorAddress)
272
273
274
275
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

276
277
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
278
279
280
281

	switch (DescriptorType)
	{
		case DTYPE_Device:
282
			Address = &DeviceDescriptor;
283
284
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
285
		case DTYPE_Configuration:
286
			Address = &ConfigurationDescriptor;
287
288
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
289
		case DTYPE_String:
290
291
			switch (DescriptorNumber)
			{
292
				case STRING_ID_Language:
293
					Address = &LanguageString;
294
295
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
296
				case STRING_ID_Manufacturer:
297
					Address = &ManufacturerString;
298
299
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
300
				case STRING_ID_Product:
301
					Address = &ProductString;
302
303
304
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
305

306
307
			break;
	}
308

309
310
311
	*DescriptorAddress = Address;
	return Size;
}
312