Descriptors.c 14.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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  Copyright 2009  Denver Gingerich (denver [at] ossguy [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"

/** HID class report descriptor. This is a special descriptor constructed with values from the
 *  USBIF HID class specification to describe the reports and capabilities of the HID device. This
 *  descriptor is parsed by the host and its contents used to determine what data (and in what encoding)
 *  the device will send, and what it may be sent back from the host. Refer to the HID specification for
 *  more details on HID report descriptors.
 *
 *  This descriptor describes the mouse HID interface's report structure.
 */
USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
{
	0x05, 0x01,          /* Usage Page (Generic Desktop)                    */
	0x09, 0x02,          /* Usage (Mouse)                                   */
	0xA1, 0x01,          /* Collection (Application)                        */
	0x09, 0x01,          /*   Usage (Pointer)                               */
	0xA1, 0x00,          /*   Collection (Physical)                         */
	0x95, 0x03,          /*     Report Count (3)                            */
	0x75, 0x01,          /*     Report Size (1)                             */
	0x05, 0x09,          /*     Usage Page (Button)                         */
	0x19, 0x01,          /*     Usage Minimum (Button 1)                    */
	0x29, 0x03,          /*     Usage Maximum (Button 3)                    */
	0x15, 0x00,          /*     Logical Minimum (0)                         */
	0x25, 0x01,          /*     Logical Maximum (1)                         */
	0x81, 0x02,          /*     Input (Data, Variable, Absolute)            */
	0x95, 0x01,          /*     Report Count (1)                            */
	0x75, 0x05,          /*     Report Size (5)                             */
	0x81, 0x01,          /*     Input (Constant)                            */
	0x75, 0x08,          /*     Report Size (8)                             */
	0x95, 0x02,          /*     Report Count (2)                            */
	0x05, 0x01,          /*     Usage Page (Generic Desktop Control)        */
	0x09, 0x30,          /*     Usage X                                     */
	0x09, 0x31,          /*     Usage Y                                     */
	0x15, 0x81,          /*     Logical Minimum (-127)                      */
	0x25, 0x7F,          /*     Logical Maximum (127)                       */
	0x81, 0x06,          /*     Input (Data, Variable, Relative)            */
	0xC0,                /*   End Collection                                */
	0xC0,                /* End Collection                                  */
};

/** Same as the MouseReport structure, but defines the keyboard HID interface's report structure. */
USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
{
	0x05, 0x01,          /* Usage Page (Generic Desktop)                    */
	0x09, 0x06,          /* Usage (Keyboard)                                */
	0xa1, 0x01,          /* Collection (Application)                        */
	0x75, 0x01,          /*   Report Size (1)                               */
	0x95, 0x08,          /*   Report Count (8)                              */
	0x05, 0x07,          /*   Usage Page (Key Codes)                        */
	0x19, 0xe0,          /*   Usage Minimum (Keyboard LeftControl)          */
	0x29, 0xe7,          /*   Usage Maximum (Keyboard Right GUI)            */
	0x15, 0x00,          /*   Logical Minimum (0)                           */
	0x25, 0x01,          /*   Logical Maximum (1)                           */
	0x81, 0x02,          /*   Input (Data, Variable, Absolute)              */
	0x95, 0x01,          /*   Report Count (1)                              */
	0x75, 0x08,          /*   Report Size (8)                               */
	0x81, 0x03,          /*   Input (Const, Variable, Absolute)             */
	0x95, 0x05,          /*   Report Count (5)                              */
	0x75, 0x01,          /*   Report Size (1)                               */
	0x05, 0x08,          /*   Usage Page (LEDs)                             */
	0x19, 0x01,          /*   Usage Minimum (Num Lock)                      */
	0x29, 0x05,          /*   Usage Maximum (Kana)                          */
	0x91, 0x02,          /*   Output (Data, Variable, Absolute)             */
	0x95, 0x01,          /*   Report Count (1)                              */
	0x75, 0x03,          /*   Report Size (3)                               */
	0x91, 0x03,          /*   Output (Const, Variable, Absolute)            */
	0x95, 0x06,          /*   Report Count (6)                              */
	0x75, 0x08,          /*   Report Size (8)                               */
	0x15, 0x00,          /*   Logical Minimum (0)                           */
	0x25, 0x65,          /*   Logical Maximum (101)                         */
	0x05, 0x07,          /*   Usage Page (Keyboard)                         */
	0x19, 0x00,          /*   Usage Minimum (Reserved (no event indicated)) */
	0x29, 0x65,          /*   Usage Maximum (Keyboard Application)          */
	0x81, 0x00,          /*   Input (Data, Array, Absolute)                 */
	0xC0                 /* End Collection                                  */
};

/** 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 =
{
123
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
124
		
125
126
127
128
	.USBSpecification       = VERSION_BCD(01.10),
	.Class                  = 0x00,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
129
				
130
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
131
		
132
133
134
	.VendorID               = 0x03EB,
	.ProductID              = 0x204D,
	.ReleaseNumber          = 0x0000,
135
		
136
137
138
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
139
		
140
	.NumberOfConfigurations = 1
141
142
143
144
145
146
147
148
149
};

/** 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 =
{
150
	.Config = 
151
		{
152
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
153

154
155
			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 2,
156
				
157
158
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
159
				
160
			.ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
161
			
162
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
163
164
		},
		
165
	.KeyboardInterface = 
166
		{
167
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
168

169
170
			.InterfaceNumber        = 0x00,
			.AlternateSetting       = 0x00,
171
			
172
			.TotalEndpoints         = 2,
173
				
174
175
176
			.Class                  = 0x03,
			.SubClass               = 0x01,
			.Protocol               = 0x01,
177
				
178
			.InterfaceStrIndex      = NO_DESCRIPTOR
179
180
		},

181
	.KeyboardHID = 
182
		{  
183
			.Header                 = {.Size = sizeof(USB_Descriptor_HID_t), .Type = DTYPE_HID},
184
			
185
186
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
187
			.TotalReportDescriptors = 1,
188
189
			.HIDReportType          = DTYPE_Report,
			.HIDReportLength        = sizeof(KeyboardReport)
190
191
		},
		
192
	.KeyboardInEndpoint = 
193
		{
194
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
195

196
197
198
199
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_IN_EPNUM),
			.Attributes             = EP_TYPE_INTERRUPT,
			.EndpointSize           = HID_EPSIZE,
			.PollingIntervalMS      = 0x02
200
201
		},

202
	.KeyboardOutEndpoint = 
203
		{
204
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
205

206
207
208
209
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | KEYBOARD_OUT_EPNUM),
			.Attributes             = EP_TYPE_INTERRUPT,
			.EndpointSize           = HID_EPSIZE,
			.PollingIntervalMS      = 0x02
210
211
		},

212
	.MouseInterface = 
213
		{
214
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
215

216
217
			.InterfaceNumber        = 0x01,
			.AlternateSetting       = 0x00,
218
			
219
			.TotalEndpoints         = 1,
220
				
221
222
223
			.Class                  = 0x03,
			.SubClass               = 0x01,
			.Protocol               = 0x02,
224
				
225
			.InterfaceStrIndex      = NO_DESCRIPTOR
226
227
		},

228
	.MouseHID = 
229
		{  
230
			.Header                 = {.Size = sizeof(USB_Descriptor_HID_t), .Type = DTYPE_HID},
231
			
232
233
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
234
			.TotalReportDescriptors = 1,
235
236
			.HIDReportType          = DTYPE_Report,
			.HIDReportLength        = sizeof(MouseReport)
237
238
		},
		
239
	.MouseInEndpoint = 
240
		{
241
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
242

243
244
245
246
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | MOUSE_IN_EPNUM),
			.Attributes             = EP_TYPE_INTERRUPT,
			.EndpointSize           = HID_EPSIZE,
			.PollingIntervalMS      = 0x02
247
248
249
250
251
252
253
254
255
		}
};

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

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

/** 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 =
{
278
	.Header                 = {.Size = USB_STRING_LEN(28), .Type = DTYPE_String},
279
		
280
	.UnicodeString          = L"LUFA Mouse and Keyboard Demo"
281
282
};

283
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
284
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
285
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
286
287
288
289
290
291
292
293
294
295
296
297
298
 *  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)
	{
299
		case DTYPE_Device: 
300
301
302
			Address = DESCRIPTOR_ADDRESS(DeviceDescriptor);
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
303
		case DTYPE_Configuration: 
304
305
306
			Address = DESCRIPTOR_ADDRESS(ConfigurationDescriptor);
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
307
		case DTYPE_String: 
308
309
			switch (DescriptorNumber)
			{
310
				case 0x00: 
311
312
313
					Address = DESCRIPTOR_ADDRESS(LanguageString);
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
314
				case 0x01: 
315
316
317
					Address = DESCRIPTOR_ADDRESS(ManufacturerString);
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
318
				case 0x02: 
319
320
321
322
323
324
					Address = DESCRIPTOR_ADDRESS(ProductString);
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
			
			break;
325
		case DTYPE_HID: 
326
327
328
329
330
331
332
333
334
335
336
			if (!(wIndex))
			{
				Address = DESCRIPTOR_ADDRESS(ConfigurationDescriptor.KeyboardHID);
				Size    = sizeof(USB_Descriptor_HID_t);
			}
			else
			{
				Address = DESCRIPTOR_ADDRESS(ConfigurationDescriptor.MouseHID);
				Size    = sizeof(USB_Descriptor_HID_t);			
			}
			break;
337
		case DTYPE_Report: 
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
			if (!(wIndex))
			{
				Address = DESCRIPTOR_ADDRESS(KeyboardReport);
				Size    = sizeof(KeyboardReport);
			}
			else
			{			
				Address = DESCRIPTOR_ADDRESS(MouseReport);
				Size    = sizeof(MouseReport);
			}
			
			break;
	}
	
	*DescriptorAddress = Address;
	return Size;
}