Descriptors.c 14.4 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
11
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
12
  
13
14
15
16
17
18
19
  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 
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
  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 = FIXED_NUM_CONFIGURATIONS
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
	.HID1_KeyboardInterface = 
166
		{
167
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
168

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

181
	.HID1_KeyboardHID = 
182
		{  
183
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_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
	.HID1_ReportINEndpoint = 
193
		{
194
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
195

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

202
	.HID2_MouseInterface = 
203
		{
204
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
205

206
207
			.InterfaceNumber        = 0x01,
			.AlternateSetting       = 0x00,
208
			
209
			.TotalEndpoints         = 1,
210
				
211
212
			.Class                  = 0x03,
			.SubClass               = 0x01,
213
			.Protocol               = HID_BOOT_MOUSE_PROTOCOL,
214
				
215
			.InterfaceStrIndex      = NO_DESCRIPTOR
216
217
		},

218
	.HID2_MouseHID = 
219
		{  
220
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_t), .Type = DTYPE_HID},
221
			
222
223
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
224
			.TotalReportDescriptors = 1,
225
226
			.HIDReportType          = DTYPE_Report,
			.HIDReportLength        = sizeof(MouseReport)
227
228
		},
		
229
	.HID2_ReportINEndpoint = 
230
		{
231
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
232

233
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | MOUSE_IN_EPNUM),
234
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
235
			.EndpointSize           = HID_EPSIZE,
236
			.PollingIntervalMS      = 0x0A
237
238
239
240
241
242
243
244
245
		}
};

/** 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 =
{
246
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
247
		
248
	.UnicodeString          = {LANGUAGE_ID_ENG}
249
250
251
252
253
254
255
256
};

/** 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 =
{
257
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
258
		
259
	.UnicodeString          = L"Dean Camera"
260
261
262
263
264
265
266
267
};

/** 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 =
{
268
	.Header                 = {.Size = USB_STRING_LEN(28), .Type = DTYPE_String},
269
		
270
	.UnicodeString          = L"LUFA Mouse and Keyboard Demo"
271
272
};

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

	void*    Address = NULL;
	uint16_t Size    = NO_DESCRIPTOR;

	switch (DescriptorType)
	{
289
		case DTYPE_Device: 
290
			Address = (void*)&DeviceDescriptor;
291
292
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
293
		case DTYPE_Configuration: 
294
			Address = (void*)&ConfigurationDescriptor;
295
296
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
297
		case DTYPE_String: 
298
299
			switch (DescriptorNumber)
			{
300
				case 0x00: 
301
					Address = (void*)&LanguageString;
302
303
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
304
				case 0x01: 
305
					Address = (void*)&ManufacturerString;
306
307
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
308
				case 0x02: 
309
					Address = (void*)&ProductString;
310
311
312
313
314
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
			
			break;
315
		case DTYPE_HID: 
316
317
			if (!(wIndex))
			{
318
				Address = (void*)&ConfigurationDescriptor.HID1_KeyboardHID;
319
				Size    = sizeof(USB_HID_Descriptor_t);
320
321
322
			}
			else
			{
323
				Address = (void*)&ConfigurationDescriptor.HID2_MouseHID;
324
				Size    = sizeof(USB_HID_Descriptor_t);			
325
326
			}
			break;
327
		case DTYPE_Report: 
328
329
			if (!(wIndex))
			{
330
				Address = (void*)&KeyboardReport;
331
332
333
334
				Size    = sizeof(KeyboardReport);
			}
			else
			{			
335
				Address = (void*)&MouseReport;
336
337
338
339
340
341
342
343
344
				Size    = sizeof(MouseReport);
			}
			
			break;
	}
	
	*DescriptorAddress = Address;
	return Size;
}