Descriptors.c 10.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)
      Based on code by Dean Camera (dean [at] fourwalledcubicle [dot] com)
	  
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
  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.
 */
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 =
{
90
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
91
		
92
93
94
95
	.USBSpecification       = VERSION_BCD(01.10),
	.Class                  = 0x00,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
96
				
97
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
98
		
99
100
101
	.VendorID               = 0x03EB,
	.ProductID              = 0x2042,
	.ReleaseNumber          = 0x0000,
102
		
103
104
105
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
106
		
107
	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
108
109
110
111
112
113
114
115
116
};

/** 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 =
{
117
	.Config = 
118
		{
119
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
120

121
122
			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 1,
123
				
124
125
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
126
				
127
			.ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
128
			
129
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
130
131
		},
		
132
	.Interface = 
133
		{
134
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
135

136
137
			.InterfaceNumber        = 0x00,
			.AlternateSetting       = 0x00,
138
			
139
			.TotalEndpoints         = 1,
140
				
141
142
			.Class                  = 0x03,
			.SubClass               = 0x01,
143
			.Protocol               = HID_BOOT_KEYBOARD_PROTOCOL,
144
				
145
			.InterfaceStrIndex      = NO_DESCRIPTOR
146
147
		},

148
	.KeyboardHID = 
149
		{  
150
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_t), .Type = DTYPE_HID},
151
			
152
153
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
154
			.TotalReportDescriptors = 1,
155
156
			.HIDReportType          = DTYPE_Report,
			.HIDReportLength        = sizeof(KeyboardReport)
157
158
		},
		
159
	.KeyboardEndpoint = 
160
		{
161
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
162

163
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_EPNUM),
164
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
165
			.EndpointSize           = KEYBOARD_EPSIZE,
166
			.PollingIntervalMS      = 0x0A
167
168
169
170
171
172
173
174
175
		},
};

/** 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 =
{
176
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
177
		
178
	.UnicodeString          = {LANGUAGE_ID_ENG}
179
180
181
182
183
184
185
186
};

/** 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 =
{
187
	.Header                 = {.Size = USB_STRING_LEN(16), .Type = DTYPE_String},
188
		
189
	.UnicodeString          = L"Denver Gingerich"
190
191
192
193
194
195
196
197
};

/** 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 =
{
198
	.Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
199
		
200
	.UnicodeString          = L"LUFA Keyboard Demo"
201
202
};

203
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
204
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
205
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
206
207
208
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 *  USB host.
 */
209
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
210
211
212
213
214
215
216
217
218
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

	void*    Address = NULL;
	uint16_t Size    = NO_DESCRIPTOR;

	switch (DescriptorType)
	{
219
		case DTYPE_Device: 
220
			Address = (void*)&DeviceDescriptor;
221
222
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
223
		case DTYPE_Configuration: 
224
			Address = (void*)&ConfigurationDescriptor;
225
226
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
227
		case DTYPE_String: 
228
229
			switch (DescriptorNumber)
			{
230
				case 0x00: 
231
					Address = (void*)&LanguageString;
232
233
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
234
				case 0x01: 
235
					Address = (void*)&ManufacturerString;
236
237
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
238
				case 0x02: 
239
					Address = (void*)&ProductString;
240
241
242
243
244
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
			
			break;
245
		case DTYPE_HID: 
246
			Address = (void*)&ConfigurationDescriptor.KeyboardHID;
247
			Size    = sizeof(USB_HID_Descriptor_t);
248
			break;
249
		case DTYPE_Report: 
250
			Address = (void*)&KeyboardReport;
251
252
253
254
255
256
257
			Size    = sizeof(KeyboardReport);
			break;
	}
	
	*DescriptorAddress = Address;
	return Size;
}