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

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

/*
10
  Copyright 2012  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
 */

#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.
 */
48
const USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
49
{
50
51
52
53
	/* Use the HID class driver's standard Keyboard report.
	 *   Max simultaneous keys: 6
	 */
	HID_DESCRIPTOR_KEYBOARD(6)
54
55
56
57
58
59
60
};

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

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

70
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
71

72
73
	.VendorID               = 0x03EB,
	.ProductID              = 0x2061,
74
	.ReleaseNumber          = VERSION_BCD(00.01),
75

76
77
78
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = USE_INTERNAL_SERIAL,
79

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

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

97
98
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
99

100
			.ConfigAttributes       = USB_CONFIG_ATTR_RESERVED,
101

102
103
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
		},
104
105

	.MS_Interface =
106
107
108
109
110
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 0,
			.AlternateSetting       = 0,
111

112
			.TotalEndpoints         = 2,
113

114
115
116
			.Class                  = MS_CSCP_MassStorageClass,
			.SubClass               = MS_CSCP_SCSITransparentSubclass,
			.Protocol               = MS_CSCP_BulkOnlyTransportProtocol,
117

118
119
120
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

121
	.MS_DataInEndpoint =
122
123
124
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

125
			.EndpointAddress        = MASS_STORAGE_IN_EPADDR,
126
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
127
			.EndpointSize           = MASS_STORAGE_IO_EPSIZE,
128
			.PollingIntervalMS      = 0x05
129
130
		},

131
	.MS_DataOutEndpoint =
132
133
134
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

135
			.EndpointAddress        = MASS_STORAGE_OUT_EPADDR,
136
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
137
			.EndpointSize           = MASS_STORAGE_IO_EPSIZE,
138
			.PollingIntervalMS      = 0x05
139
140
		},

141
	.HID_KeyboardInterface =
142
143
144
145
146
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 1,
			.AlternateSetting       = 0,
147

148
			.TotalEndpoints         = 1,
149

150
151
152
			.Class                  = HID_CSCP_HIDClass,
			.SubClass               = HID_CSCP_BootSubclass,
			.Protocol               = HID_CSCP_KeyboardBootProtocol,
153

154
155
156
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

157
158
	.HID_KeyboardHID =
		{
159
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
160

161
162
163
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
			.TotalReportDescriptors = 1,
164
			.HIDReportType          = HID_DTYPE_Report,
165
166
			.HIDReportLength        = sizeof(KeyboardReport)
		},
167
168

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

172
			.EndpointAddress        = KEYBOARD_EPADDR,
173
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
174
			.EndpointSize           = KEYBOARD_EPSIZE,
175
			.PollingIntervalMS      = 0x05
176
177
178
179
180
181
182
		},
};

/** 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.
 */
183
const USB_Descriptor_String_t PROGMEM LanguageString =
184
185
{
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
186

187
188
189
190
191
192
193
	.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.
 */
194
const USB_Descriptor_String_t PROGMEM ManufacturerString =
195
196
{
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
197

198
199
200
201
202
203
204
	.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.
 */
205
const USB_Descriptor_String_t PROGMEM ProductString =
206
207
{
	.Header                 = {.Size = USB_STRING_LEN(35), .Type = DTYPE_String},
208

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

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

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

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

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