Descriptors.c 11.1 KB
Newer Older
1
2
3
/*
             LUFA Library
     Copyright (C) Dean Camera, 2010.
4

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

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

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
21
22
23
24
25
26
27
28
29
30
31
32
  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
 *
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
45
46
47
#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},
48

49
	.USBSpecification       = VERSION_BCD(01.10),
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              = 0x2048,
58
	.ReleaseNumber          = VERSION_BCD(00.01),
59

60
61
62
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
63

64
65
66
67
68
69
70
71
72
73
	.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 =
{
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_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
85

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

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

			.InterfaceNumber          = 0,
			.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(01.00),
111
			.TotalLength              = sizeof(USB_Audio_Descriptor_Interface_AC_t),
112

113
			.InCollection             = 1,
114
			.InterfaceNumber          = 1,
115
116
		},

117
	.Audio_StreamInterface =
118
119
120
121
122
		{
			.Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber          = 1,
			.AlternateSetting         = 0,
123

124
			.TotalEndpoints           = 2,
125

126
127
128
			.Class                    = AUDIO_CSCP_AudioClass,
			.SubClass                 = AUDIO_CSCP_MIDIStreamingSubclass,
			.Protocol                 = AUDIO_CSCP_StreamingProtocol,
129

130
131
			.InterfaceStrIndex        = NO_DESCRIPTOR
		},
132
133

	.Audio_StreamInterface_SPC =
134
		{
135
136
			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_AudioInterface_AS_t), .Type = DTYPE_CSInterface},
			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_General,
137
138

			.AudioSpecification       = VERSION_BCD(01.00),
139

140
141
142
143
			.TotalLength              = (sizeof(USB_Descriptor_Configuration_t) -
			                             offsetof(USB_Descriptor_Configuration_t, Audio_StreamInterface_SPC))
		},

144
	.MIDI_In_Jack_Emb =
145
		{
146
147
			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_InputJack_t), .Type = DTYPE_CSInterface},
			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_InputTerminal,
148

149
			.JackType                 = MIDI_JACKTYPE_Embedded,
150
			.JackID                   = 0x01,
151

152
153
154
			.JackStrIndex             = NO_DESCRIPTOR
		},

155
	.MIDI_In_Jack_Ext =
156
		{
157
158
			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_InputJack_t), .Type = DTYPE_CSInterface},
			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_InputTerminal,
159

160
			.JackType                 = MIDI_JACKTYPE_External,
161
			.JackID                   = 0x02,
162

163
164
			.JackStrIndex             = NO_DESCRIPTOR
		},
165
166

	.MIDI_Out_Jack_Emb =
167
		{
168
169
			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_OutputJack_t), .Type = DTYPE_CSInterface},
			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_OutputTerminal,
170

171
			.JackType                 = MIDI_JACKTYPE_Embedded,
172
173
174
175
176
			.JackID                   = 0x03,

			.NumberOfPins             = 1,
			.SourceJackID             = {0x02},
			.SourcePinID              = {0x01},
177

178
179
180
			.JackStrIndex             = NO_DESCRIPTOR
		},

181
	.MIDI_Out_Jack_Ext =
182
		{
183
184
			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_OutputJack_t), .Type = DTYPE_CSInterface},
			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_OutputTerminal,
185

186
			.JackType                 = MIDI_JACKTYPE_External,
187
188
189
190
191
			.JackID                   = 0x04,

			.NumberOfPins             = 1,
			.SourceJackID             = {0x01},
			.SourcePinID              = {0x01},
192

193
194
195
			.JackStrIndex             = NO_DESCRIPTOR
		},

196
	.MIDI_In_Jack_Endpoint =
197
		{
198
			.Endpoint =
199
				{
200
					.Header              = {.Size = sizeof(USB_Audio_Descriptor_StreamEndpoint_Std_t), .Type = DTYPE_Endpoint},
201
202
203
204

					.EndpointAddress     = (ENDPOINT_DESCRIPTOR_DIR_OUT | MIDI_STREAM_OUT_EPNUM),
					.Attributes          = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
					.EndpointSize        = MIDI_STREAM_EPSIZE,
205
					.PollingIntervalMS   = 0x0A
206
				},
207

208
209
210
			.Refresh                  = 0,
			.SyncEndpointNumber       = 0
		},
211
212

	.MIDI_In_Jack_Endpoint_SPC =
213
		{
214
215
			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_Jack_Endpoint_t), .Type = DTYPE_CSEndpoint},
			.Subtype                  = AUDIO_DSUBTYPE_CSEndpoint_General,
216
217
218
219
220

			.TotalEmbeddedJacks       = 0x01,
			.AssociatedJackID         = {0x01}
		},

221
	.MIDI_Out_Jack_Endpoint =
222
		{
223
			.Endpoint =
224
				{
225
					.Header              = {.Size = sizeof(USB_Audio_Descriptor_StreamEndpoint_Std_t), .Type = DTYPE_Endpoint},
226
227
228
229

					.EndpointAddress     = (ENDPOINT_DESCRIPTOR_DIR_IN | MIDI_STREAM_IN_EPNUM),
					.Attributes          = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
					.EndpointSize        = MIDI_STREAM_EPSIZE,
230
					.PollingIntervalMS   = 0x0A
231
				},
232

233
234
235
			.Refresh                  = 0,
			.SyncEndpointNumber       = 0
		},
236
237

	.MIDI_Out_Jack_Endpoint_SPC =
238
		{
239
240
			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_Jack_Endpoint_t), .Type = DTYPE_CSEndpoint},
			.Subtype                  = AUDIO_DSUBTYPE_CSEndpoint_General,
241
242
243
244
245
246
247
248
249
250
251
252
253

			.TotalEmbeddedJacks       = 0x01,
			.AssociatedJackID         = {0x03}
		}
};

/** 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},
254

255
256
257
258
259
260
261
262
263
264
	.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},
265

266
267
268
269
270
271
272
273
274
275
	.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(14), .Type = DTYPE_String},
276

277
278
279
280
281
282
283
284
285
	.UnicodeString          = L"LUFA MIDI 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.
 */
286
287
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                    const uint8_t wIndex,
288
                                    const void** const DescriptorAddress)
289
290
291
292
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

293
294
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
295
296
297

	switch (DescriptorType)
	{
298
		case DTYPE_Device:
299
			Address = &DeviceDescriptor;
300
301
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
302
		case DTYPE_Configuration:
303
			Address = &ConfigurationDescriptor;
304
305
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
306
		case DTYPE_String:
307
308
			switch (DescriptorNumber)
			{
309
				case 0x00:
310
					Address = &LanguageString;
311
312
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
313
				case 0x01:
314
					Address = &ManufacturerString;
315
316
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
317
				case 0x02:
318
					Address = &ProductString;
319
320
321
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
322

323
324
			break;
	}
325

326
327
328
	*DescriptorAddress = Address;
	return Size;
}
329