Descriptors.c 14.5 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)
  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
12
13

  Permission to use, copy, modify, distribute, and sell this
14
  software and its documentation for any purpose is hereby granted
15
  without fee, provided that the above copyright notice appear in
16
  all copies and that both that the copyright notice and this
17
18
19
  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
20
21
22
23
24
25
26
27
28
29
30
31
32
33
  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
 *
34
 *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special
35
 *  computer-readable structures which the host requests upon device enumeration, to determine
36
 *  the device's capabilities and functions.
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
123
 */

#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 =
{
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
124

125
	.USBSpecification       = VERSION_BCD(01.10),
126
127
128
	.Class                  = USB_CSCP_NoDeviceClass,
	.SubClass               = USB_CSCP_NoDeviceSubclass,
	.Protocol               = USB_CSCP_NoDeviceProtocol,
129

130
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
131

132
133
	.VendorID               = 0x03EB,
	.ProductID              = 0x204D,
134
	.ReleaseNumber          = VERSION_BCD(00.01),
135

136
137
138
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
139

140
141
142
143
144
145
146
147
148
149
	.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 =
{
150
	.Config =
151
152
153
154
155
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

			.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
163
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
		},
164
165

	.HID1_KeyboardInterface =
166
167
168
169
170
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 0x00,
			.AlternateSetting       = 0x00,
171

172
			.TotalEndpoints         = 2,
173

174
175
176
			.Class                  = HID_CSCP_HIDClass,
			.SubClass               = HID_CSCP_BootSubclass,
			.Protocol               = HID_CSCP_KeyboardBootProtocol,
177

178
179
180
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

181
182
	.HID1_KeyboardHID =
		{
183
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
184

185
186
187
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
			.TotalReportDescriptors = 1,
188
			.HIDReportType          = HID_DTYPE_Report,
189
190
			.HIDReportLength        = sizeof(KeyboardReport)
		},
191
192

	.HID1_ReportINEndpoint =
193
194
195
196
197
198
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_IN_EPNUM),
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = HID_EPSIZE,
199
			.PollingIntervalMS      = 0x01
200
201
		},

202
	.HID1_ReportOUTEndpoint =
203
204
205
206
207
208
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | KEYBOARD_OUT_EPNUM),
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = HID_EPSIZE,
209
			.PollingIntervalMS      = 0x01
210
211
		},

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

			.InterfaceNumber        = 0x01,
			.AlternateSetting       = 0x00,
218

219
			.TotalEndpoints         = 1,
220

221
222
223
			.Class                  = HID_CSCP_HIDClass,
			.SubClass               = HID_CSCP_BootSubclass,
			.Protocol               = HID_CSCP_MouseBootProtocol,
224

225
226
227
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

228
229
	.HID2_MouseHID =
		{
230
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
231

232
233
234
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
			.TotalReportDescriptors = 1,
235
			.HIDReportType          = HID_DTYPE_Report,
236
237
			.HIDReportLength        = sizeof(MouseReport)
		},
238
239

	.HID2_ReportINEndpoint =
240
241
242
243
244
245
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | MOUSE_IN_EPNUM),
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = HID_EPSIZE,
246
			.PollingIntervalMS      = 0x01
247
248
249
250
251
252
253
254
255
256
		}
};

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

258
259
260
261
262
263
264
265
266
267
	.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},
268

269
270
271
272
273
274
275
276
277
278
	.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(28), .Type = DTYPE_String},
279

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

296
297
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
298
299
300

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

326
			break;
327
		case HID_DTYPE_HID:
328
329
			if (!(wIndex))
			{
330
				Address = &ConfigurationDescriptor.HID1_KeyboardHID;
331
				Size    = sizeof(USB_HID_Descriptor_HID_t);
332
333
334
			}
			else
			{
335
				Address = &ConfigurationDescriptor.HID2_MouseHID;
336
				Size    = sizeof(USB_HID_Descriptor_HID_t);
337
338
			}
			break;
339
		case HID_DTYPE_Report:
340
341
			if (!(wIndex))
			{
342
				Address = &KeyboardReport;
343
344
345
				Size    = sizeof(KeyboardReport);
			}
			else
346
			{
347
				Address = &MouseReport;
348
349
				Size    = sizeof(MouseReport);
			}
350

351
352
			break;
	}
353

354
355
356
	*DescriptorAddress = Address;
	return Size;
}
357