Descriptors.c 8.41 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

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

#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.
 */
46
const USB_Descriptor_HIDReport_Datatype_t PROGMEM GenericReport[] =
47
{
48
	/* Use the HID class driver's standard Vendor HID report.
49
	 *  Vendor Usage Page: 0
50
51
52
53
54
55
	 *  Vendor Collection Usage: 1
	 *  Vendor Report IN Usage: 2
	 *  Vendor Report OUT Usage: 3
	 *  Vendor Report Size: GENERIC_REPORT_SIZE
	 */
	HID_DESCRIPTOR_VENDOR(0x00, 0x01, 0x02, 0x03, GENERIC_REPORT_SIZE)
56
57
58
59
60
61
62
};

/** 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.
 */
63
const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
64
65
{
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
66

67
	.USBSpecification       = VERSION_BCD(01.10),
68
69
70
	.Class                  = USB_CSCP_NoDeviceClass,
	.SubClass               = USB_CSCP_NoDeviceSubclass,
	.Protocol               = USB_CSCP_NoDeviceProtocol,
71

72
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
73

74
75
	.VendorID               = 0x03EB,
	.ProductID              = 0x204F,
76
	.ReleaseNumber          = VERSION_BCD(00.01),
77

78
79
80
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
81

82
83
84
85
86
87
88
89
	.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.
 */
90
const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
91
{
92
	.Config =
93
94
95
96
97
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 1,
98

99
100
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
101

102
			.ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
103

104
105
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
		},
106
107

	.HID_Interface =
108
109
110
111
112
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 0x00,
			.AlternateSetting       = 0x00,
113

114
			.TotalEndpoints         = 1,
115

116
117
118
			.Class                  = HID_CSCP_HIDClass,
			.SubClass               = HID_CSCP_NonBootSubclass,
			.Protocol               = HID_CSCP_NonBootProtocol,
119

120
121
122
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

123
	.HID_GenericHID =
124
		{
125
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
126

127
128
129
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
			.TotalReportDescriptors = 1,
130
			.HIDReportType          = HID_DTYPE_Report,
131
132
133
			.HIDReportLength        = sizeof(GenericReport)
		},

134
	.HID_ReportINEndpoint =
135
136
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
137

138
			.EndpointAddress        = (ENDPOINT_DIR_IN | GENERIC_IN_EPNUM),
139
140
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = GENERIC_EPSIZE,
141
			.PollingIntervalMS      = 0x01
142
143
144
145
146
147
148
		},
};

/** 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.
 */
149
const USB_Descriptor_String_t PROGMEM LanguageString =
150
151
{
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
152

153
154
155
156
157
158
159
	.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.
 */
160
const USB_Descriptor_String_t PROGMEM ManufacturerString =
161
162
{
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
163

164
165
166
167
168
169
170
	.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.
 */
171
const USB_Descriptor_String_t PROGMEM ProductString =
172
173
{
	.Header                 = {.Size = USB_STRING_LEN(21), .Type = DTYPE_String},
174

175
176
177
178
179
180
181
182
183
	.UnicodeString          = L"LUFA Generic HID 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.
 */
184
185
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                    const uint8_t wIndex,
186
                                    const void** const DescriptorAddress)
187
188
189
190
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

191
192
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
193
194
195
196

	switch (DescriptorType)
	{
		case DTYPE_Device:
197
			Address = &DeviceDescriptor;
198
199
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
200
		case DTYPE_Configuration:
201
			Address = &ConfigurationDescriptor;
202
203
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
204
		case DTYPE_String:
205
206
			switch (DescriptorNumber)
			{
207
				case 0x00:
208
					Address = &LanguageString;
209
210
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
211
				case 0x01:
212
					Address = &ManufacturerString;
213
214
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
215
				case 0x02:
216
					Address = &ProductString;
217
218
219
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
220

221
			break;
222
		case HID_DTYPE_HID:
223
			Address = &ConfigurationDescriptor.HID_GenericHID;
224
			Size    = sizeof(USB_HID_Descriptor_HID_t);
225
			break;
226
		case HID_DTYPE_Report:
227
			Address = &GenericReport;
228
229
230
			Size    = sizeof(GenericReport);
			break;
	}
231

232
233
234
	*DescriptorAddress = Address;
	return Size;
}
235