Descriptors.c 11.1 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

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

12
13
14
15
16
17
18
  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 
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
  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 = FIXED_NUM_CONFIGURATIONS
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
	.Audio_ControlInterface = 
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
	.Audio_ControlInterface_SPC = 
106
		{
107
			.Header                   = {.Size = sizeof(USB_Audio_Interface_AC_t), .Type = DTYPE_AudioInterface},
108
			.Subtype                  = DSUBTYPE_Header,
109
			
110
			.ACSpecification          = VERSION_BCD(01.00),
111
			.TotalLength              = sizeof(USB_Audio_Interface_AC_t),
112
			
113
114
			.InCollection             = 1,
			.InterfaceNumbers         = {1},			
115
116
		},

117
	.Audio_StreamInterface = 
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
	.Audio_StreamInterface_SPC = 
134
		{
135
			.Header                   = {.Size = sizeof(USB_Audio_Interface_MIDI_AS_t), .Type = DTYPE_AudioInterface},
136
			.Subtype                  = DSUBTYPE_General,
137

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	void*    Address = NULL;
	uint16_t Size    = NO_DESCRIPTOR;

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