Descriptors.c 11 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                  = 0x00,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
53
				
54
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
55
		
56
57
58
	.VendorID               = 0x03EB,
	.ProductID              = 0x2048,
	.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
			.ACSpecification          = VERSION_BCD(01.00),
			.TotalLength              = sizeof(USB_AudioInterface_AC_t),
112
			
113
114
			.InCollection             = 1,
			.InterfaceNumbers         = {1},			
115
116
		},

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

121
122
			.InterfaceNumber          = 1,
			.AlternateSetting         = 0,
123
			
124
			.TotalEndpoints           = 2,
125
				
126
127
128
			.Class                    = 0x01,
			.SubClass                 = 0x03,
			.Protocol                 = 0x00,
129
				
130
			.InterfaceStrIndex        = NO_DESCRIPTOR
131
132
		},
		
133
	.AudioStreamInterface_SPC = 
134
		{
135
136
			.Header                   = {.Size = sizeof(USB_AudioInterface_MIDI_AS_t), .Type = DTYPE_AudioInterface},
			.Subtype                  = DSUBTYPE_General,
137

138
			.AudioSpecification       = VERSION_BCD(01.00),
139
			
140
			.TotalLength              = (sizeof(USB_Descriptor_Configuration_t) - offsetof(USB_Descriptor_Configuration_t, AudioStreamInterface_SPC))
141
142
		},

143
	.MIDI_In_Jack_Emb = 
144
		{
145
146
			.Header                   = {.Size = sizeof(USB_MIDI_In_Jack_t), .Type = DTYPE_AudioInterface},
			.Subtype                  = DSUBTYPE_InputJack,
147
			
148
149
			.JackType                 = JACKTYPE_EMBEDDED,
			.JackID                   = 0x01,
150
			
151
			.JackStrIndex             = NO_DESCRIPTOR
152
153
		},

154
	.MIDI_In_Jack_Ext = 
155
		{
156
157
			.Header                   = {.Size = sizeof(USB_MIDI_In_Jack_t), .Type = DTYPE_AudioInterface},
			.Subtype                  = DSUBTYPE_InputJack,
158
			
159
160
			.JackType                 = JACKTYPE_EXTERNAL,
			.JackID                   = 0x02,
161
			
162
			.JackStrIndex             = NO_DESCRIPTOR
163
164
		},
		
165
	.MIDI_Out_Jack_Emb = 
166
		{
167
168
			.Header                   = {.Size = sizeof(USB_MIDI_Out_Jack_t), .Type = DTYPE_AudioInterface},
			.Subtype                  = DSUBTYPE_OutputJack,
169
			
170
171
			.JackType                 = JACKTYPE_EMBEDDED,
			.JackID                   = 0x03,
172

173
174
175
			.NumberOfPins             = 1,
			.SourceJackID             = {0x02},
			.SourcePinID              = {0x01},
176
			
177
			.JackStrIndex             = NO_DESCRIPTOR
178
179
		},

180
	.MIDI_Out_Jack_Ext = 
181
		{
182
183
			.Header                   = {.Size = sizeof(USB_MIDI_Out_Jack_t), .Type = DTYPE_AudioInterface},
			.Subtype                  = DSUBTYPE_OutputJack,
184
			
185
186
			.JackType                 = JACKTYPE_EXTERNAL,
			.JackID                   = 0x04,
187

188
189
190
			.NumberOfPins             = 1,
			.SourceJackID             = {0x01},
			.SourcePinID              = {0x01},
191
			
192
			.JackStrIndex             = NO_DESCRIPTOR
193
194
		},

195
	.MIDI_In_Jack_Endpoint = 
196
		{
197
			.Endpoint = 
198
				{
199
					.Header              = {.Size = sizeof(USB_AudioStreamEndpoint_Std_t), .Type = DTYPE_Endpoint},
200

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,
					.PollingIntervalMS   = 0
205
206
				},
			
207
208
			.Refresh                  = 0,
			.SyncEndpointNumber       = 0
209
210
		},
		
211
	.MIDI_In_Jack_Endpoint_SPC = 
212
		{
213
214
			.Header                   = {.Size = sizeof(USB_MIDI_Jack_Endpoint_t), .Type = DTYPE_AudioEndpoint},
			.Subtype                  = DSUBTYPE_General,
215

216
217
			.TotalEmbeddedJacks       = 0x01,
			.AssociatedJackID         = {0x01}
218
219
		},

220
	.MIDI_Out_Jack_Endpoint = 
221
		{
222
			.Endpoint = 
223
				{
224
					.Header              = {.Size = sizeof(USB_AudioStreamEndpoint_Std_t), .Type = DTYPE_Endpoint},
225

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,
					.PollingIntervalMS   = 0
230
231
				},
			
232
233
			.Refresh                  = 0,
			.SyncEndpointNumber       = 0
234
235
		},
		
236
	.MIDI_Out_Jack_Endpoint_SPC = 
237
		{
238
239
			.Header                   = {.Size = sizeof(USB_MIDI_Jack_Endpoint_t), .Type = DTYPE_AudioEndpoint},
			.Subtype                  = DSUBTYPE_General,
240

241
242
			.TotalEmbeddedJacks       = 0x01,
			.AssociatedJackID         = {0x03}
243
244
245
246
247
248
249
250
251
		}
};

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

/** 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 =
{
263
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
264
		
265
	.UnicodeString          = L"Dean Camera"
266
267
268
269
270
271
272
273
};

/** 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 =
{
274
	.Header                 = {.Size = USB_STRING_LEN(14), .Type = DTYPE_String},
275
		
276
	.UnicodeString          = L"LUFA MIDI Demo"
277
278
};

279
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
280
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
281
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
282
283
284
285
286
287
288
289
290
291
292
293
294
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 *  USB host.
 */
uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

	void*    Address = NULL;
	uint16_t Size    = NO_DESCRIPTOR;

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