Descriptors.c 10.4 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
  Copyright 2010  Matthias Hullin (lufa [at] matthias [dot] hullin [dot] net)

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
 */

#include "Descriptors.h"

/* On some devices, there is a factory set internal serial number which can be automatically sent to the host as
 * the device's serial number when the Device Descriptor's .SerialNumStrIndex entry is set to USE_INTERNAL_SERIAL.
 * This allows the host to track a device across insertions on different ports, allowing them to retain allocated
 * resources like COM port numbers and drivers. On demos using this feature, give a warning on unsupported devices
 * so that the user can supply their own serial number descriptor instead or remove the USE_INTERNAL_SERIAL value
 * from the Device Descriptor (forcing the host to generate a serial number for each device from the VID, PID and
 * port location).
 */
#if (USE_INTERNAL_SERIAL == NO_DESCRIPTOR)
	#warning USE_INTERNAL_SERIAL is not available on this AVR - please manually construct a device serial descriptor.
#endif

/** 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[] =
{
61
62
63
64
	/* Use the HID class driver's standard Keyboard report.
	 *   Max simultaneous keys: 6
	 */
	HID_DESCRIPTOR_KEYBOARD(6)
65
66
67
68
69
70
71
72
73
74
};

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

76
	.USBSpecification       = VERSION_BCD(01.10),
77
78
79
	.Class                  = USB_CSCP_NoDeviceClass,
	.SubClass               = USB_CSCP_NoDeviceSubclass,
	.Protocol               = USB_CSCP_NoDeviceProtocol,
80

81
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
82

83
84
	.VendorID               = 0x03EB,
	.ProductID              = 0x2061,
85
	.ReleaseNumber          = VERSION_BCD(00.01),
86

87
88
89
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = USE_INTERNAL_SERIAL,
90

91
92
93
94
95
96
97
98
99
100
	.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 =
{
101
	.Config =
102
103
104
105
106
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 2,
107

108
109
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
110

111
			.ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
112

113
114
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
		},
115
116

	.MS_Interface =
117
118
119
120
121
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 0,
			.AlternateSetting       = 0,
122

123
			.TotalEndpoints         = 2,
124

125
126
127
			.Class                  = MS_CSCP_MassStorageClass,
			.SubClass               = MS_CSCP_SCSITransparentSubclass,
			.Protocol               = MS_CSCP_BulkOnlyTransportProtocol,
128

129
130
131
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

132
	.MS_DataInEndpoint =
133
134
135
136
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | MASS_STORAGE_IN_EPNUM),
137
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
138
			.EndpointSize           = MASS_STORAGE_IO_EPSIZE,
139
			.PollingIntervalMS      = 0x01
140
141
		},

142
	.MS_DataOutEndpoint =
143
144
145
146
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | MASS_STORAGE_OUT_EPNUM),
147
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
148
			.EndpointSize           = MASS_STORAGE_IO_EPSIZE,
149
			.PollingIntervalMS      = 0x01
150
151
		},

152
	.HID_KeyboardInterface =
153
154
155
156
157
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 1,
			.AlternateSetting       = 0,
158

159
			.TotalEndpoints         = 1,
160

161
162
163
			.Class                  = HID_CSCP_HIDClass,
			.SubClass               = HID_CSCP_BootSubclass,
			.Protocol               = HID_CSCP_KeyboardBootProtocol,
164

165
166
167
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

168
169
	.HID_KeyboardHID =
		{
170
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
171

172
173
174
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
			.TotalReportDescriptors = 1,
175
			.HIDReportType          = HID_DTYPE_Report,
176
177
			.HIDReportLength        = sizeof(KeyboardReport)
		},
178
179

	.HID_ReportINEndpoint =
180
181
182
183
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_EPNUM),
184
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
185
			.EndpointSize           = KEYBOARD_EPSIZE,
186
			.PollingIntervalMS      = 0x01
187
188
189
190
191
192
193
194
195
196
		},
};

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

198
199
200
201
202
203
204
205
206
207
	.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},
208

209
210
211
212
213
214
215
216
217
218
	.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(35), .Type = DTYPE_String},
219

220
221
222
223
224
225
226
227
228
	.UnicodeString          = L"LUFA Mass Storage 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.
 */
229
230
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                    const uint8_t wIndex,
231
                                    const void** const DescriptorAddress)
232
233
234
235
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

236
237
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
238
239
240

	switch (DescriptorType)
	{
241
		case DTYPE_Device:
242
			Address = &DeviceDescriptor;
243
244
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
245
		case DTYPE_Configuration:
246
			Address = &ConfigurationDescriptor;
247
248
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
249
		case DTYPE_String:
250
251
			switch (DescriptorNumber)
			{
252
				case 0x00:
253
					Address = &LanguageString;
254
255
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
256
				case 0x01:
257
					Address = &ManufacturerString;
258
259
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
260
				case 0x02:
261
					Address = &ProductString;
262
263
264
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
265

266
			break;
267
		case HID_DTYPE_HID:
268
			Address = &ConfigurationDescriptor.HID_KeyboardHID;
269
			Size    = sizeof(USB_HID_Descriptor_HID_t);
270
			break;
271
		case HID_DTYPE_Report:
272
			Address = &KeyboardReport;
273
274
275
			Size    = sizeof(KeyboardReport);
			break;
	}
276

277
278
279
	*DescriptorAddress = Address;
	return Size;
}
280