Descriptors.c 10 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
10
  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
  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
 */

#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[] =
{
49
50
51
52
53
54
55
56
57
58
	HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
	HID_RI_USAGE(8, 0x06), /* Keyboard */
	HID_RI_COLLECTION(8, 0x01), /* Application */
	    HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
	    HID_RI_USAGE_MINIMUM(8, 0xE0), /* Keyboard Left Control */
	    HID_RI_USAGE_MAXIMUM(8, 0xE7), /* Keyboard Right GUI */
	    HID_RI_LOGICAL_MINIMUM(8, 0x00),
	    HID_RI_LOGICAL_MAXIMUM(8, 0x01),
	    HID_RI_REPORT_SIZE(8, 0x01),
	    HID_RI_REPORT_COUNT(8, 0x08),
59
	    HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
	    HID_RI_REPORT_COUNT(8, 0x01),
	    HID_RI_REPORT_SIZE(8, 0x08),
	    HID_RI_INPUT(8, HID_IOF_CONSTANT),
	    HID_RI_USAGE_PAGE(8, 0x08), /* LEDs */
	    HID_RI_USAGE_MINIMUM(8, 0x01), /* Num Lock */
	    HID_RI_USAGE_MAXIMUM(8, 0x05), /* Kana */
	    HID_RI_REPORT_COUNT(8, 0x05),
	    HID_RI_REPORT_SIZE(8, 0x01),
	    HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
	    HID_RI_REPORT_COUNT(8, 0x01),
	    HID_RI_REPORT_SIZE(8, 0x03),
	    HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
	    HID_RI_LOGICAL_MINIMUM(8, 0x00),
	    HID_RI_LOGICAL_MAXIMUM(8, 0x65),
	    HID_RI_USAGE_PAGE(8, 0x07), /* Keyboard */
	    HID_RI_USAGE_MINIMUM(8, 0x00), /* Reserved (no event indicated) */
	    HID_RI_USAGE_MAXIMUM(8, 0x65), /* Keyboard Application */
	    HID_RI_REPORT_COUNT(8, 0x06),
	    HID_RI_REPORT_SIZE(8, 0x08),
79
	    HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
80
	HID_RI_END_COLLECTION(0),
81
82
83
84
85
86
87
88
89
90
};

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

92
	.USBSpecification       = VERSION_BCD(01.10),
93
94
95
	.Class                  = USB_CSCP_NoDeviceClass,
	.SubClass               = USB_CSCP_NoDeviceSubclass,
	.Protocol               = USB_CSCP_NoDeviceProtocol,
96

97
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
98

99
100
	.VendorID               = 0x03EB,
	.ProductID              = 0x2042,
101
	.ReleaseNumber          = VERSION_BCD(00.01),
102

103
104
105
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
106

107
108
109
110
111
112
113
114
115
116
	.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 =
{
117
	.Config =
118
119
120
121
122
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

			.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
130
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
		},
131
132

	.HID_Interface =
133
134
135
136
137
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 0x00,
			.AlternateSetting       = 0x00,
138

139
			.TotalEndpoints         = 2,
140

141
142
143
			.Class                  = HID_CSCP_HIDClass,
			.SubClass               = HID_CSCP_BootSubclass,
			.Protocol               = HID_CSCP_KeyboardBootProtocol,
144

145
146
147
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

148
149
	.HID_KeyboardHID =
		{
150
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
151

152
153
154
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
			.TotalReportDescriptors = 1,
155
			.HIDReportType          = HID_DTYPE_Report,
156
157
			.HIDReportLength        = sizeof(KeyboardReport)
		},
158
159

	.HID_ReportINEndpoint =
160
161
162
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

163
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_IN_EPNUM),
164
165
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = KEYBOARD_EPSIZE,
166
			.PollingIntervalMS      = 0x01
167
168
		},

169
	.HID_ReportOUTEndpoint =
170
171
172
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

173
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | KEYBOARD_OUT_EPNUM),
174
175
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = KEYBOARD_EPSIZE,
176
			.PollingIntervalMS      = 0x01
177
178
179
180
181
182
183
184
185
186
		}
};

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

188
189
190
191
192
193
194
195
196
	.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 =
{
197
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
198

199
	.UnicodeString          = L"Dean Camera"
200
201
202
203
204
205
206
207
208
};

/** 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(18), .Type = DTYPE_String},
209

210
211
212
213
214
215
216
217
218
	.UnicodeString          = L"LUFA 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.
 */
219
220
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                    const uint8_t wIndex,
221
                                    const void** const DescriptorAddress)
222
223
224
225
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

226
227
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
228
229
230

	switch (DescriptorType)
	{
231
		case DTYPE_Device:
232
			Address = &DeviceDescriptor;
233
234
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
235
		case DTYPE_Configuration:
236
			Address = &ConfigurationDescriptor;
237
238
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
239
		case DTYPE_String:
240
241
			switch (DescriptorNumber)
			{
242
				case 0x00:
243
					Address = &LanguageString;
244
245
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
246
				case 0x01:
247
					Address = &ManufacturerString;
248
249
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
250
				case 0x02:
251
					Address = &ProductString;
252
253
254
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
255

256
			break;
257
		case HID_DTYPE_HID:
258
			Address = &ConfigurationDescriptor.HID_KeyboardHID;
259
			Size    = sizeof(USB_HID_Descriptor_HID_t);
260
			break;
261
		case HID_DTYPE_Report:
262
			Address = &KeyboardReport;
263
264
265
			Size    = sizeof(KeyboardReport);
			break;
	}
266

267
268
269
	*DescriptorAddress = Address;
	return Size;
}
270