Descriptors.c 9.19 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
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.
 */
USB_Descriptor_HIDReport_Datatype_t PROGMEM JoystickReport[] =
{
48
49
50
51
52
53
54
55
56
57
58
59
	HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
	HID_RI_USAGE(8, 0x04), /* Joystick */
	HID_RI_COLLECTION(8, 0x01), /* Application */
	    HID_RI_USAGE(8, 0x01), /* Pointer */
	    HID_RI_COLLECTION(8, 0x00), /* Physical */
	        HID_RI_USAGE(8, 0x30), /* Usage X */
	        HID_RI_USAGE(8, 0x31), /* Usage Y */
	        HID_RI_LOGICAL_MINIMUM(8, -100),
	        HID_RI_LOGICAL_MAXIMUM(8, 100),
	        HID_RI_REPORT_SIZE(8, 0x08),
	        HID_RI_REPORT_COUNT(8, 0x02),
	        HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
60
	    HID_RI_END_COLLECTION(0),
61
62
63
64
65
66
67
68
69
70
71
	    HID_RI_USAGE_PAGE(8, 0x09), /* Button */
	    HID_RI_USAGE(8, 0x02), /* Button 1 */
	    HID_RI_USAGE(8, 0x01), /* Button 2 */
	    HID_RI_LOGICAL_MINIMUM(8, 0x00),
	    HID_RI_LOGICAL_MAXIMUM(8, 0x01),
	    HID_RI_REPORT_SIZE(8, 0x01),
	    HID_RI_REPORT_COUNT(8, 0x02),
	    HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
	    HID_RI_REPORT_SIZE(8, 0x06),
	    HID_RI_REPORT_COUNT(8, 0x01),
	    HID_RI_INPUT(8, HID_IOF_CONSTANT),
72
	HID_RI_END_COLLECTION(0),
73
74
75
76
77
78
79
80
81
82
};

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

84
	.USBSpecification       = VERSION_BCD(01.10),
85
86
87
	.Class                  = USB_CSCP_NoDeviceClass,
	.SubClass               = USB_CSCP_NoDeviceSubclass,
	.Protocol               = USB_CSCP_NoDeviceProtocol,
88

89
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
90

91
92
	.VendorID               = 0x03EB,
	.ProductID              = 0x2043,
93
	.ReleaseNumber          = VERSION_BCD(00.01),
94

95
96
97
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
98

99
100
101
102
103
104
105
106
107
108
	.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 =
{
109
	.Config =
110
111
112
113
114
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

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

116
117
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
118

119
			.ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
120

121
122
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
		},
123
124

	.HID_Interface =
125
126
127
128
129
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 0x00,
			.AlternateSetting       = 0x00,
130

131
			.TotalEndpoints         = 1,
132

133
134
135
			.Class                  = HID_CSCP_HIDClass,
			.SubClass               = HID_CSCP_NonBootSubclass,
			.Protocol               = HID_CSCP_NonBootProtocol,
136

137
138
139
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

140
	.HID_JoystickHID =
141
		{
142
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
143

144
145
146
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
			.TotalReportDescriptors = 1,
147
			.HIDReportType          = HID_DTYPE_Report,
148
149
150
			.HIDReportLength        = sizeof(JoystickReport)
		},

151
	.HID_ReportINEndpoint =
152
153
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
154

155
156
157
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | JOYSTICK_EPNUM),
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = JOYSTICK_EPSIZE,
158
			.PollingIntervalMS      = 0x01
159
		}
160
161
162
163
164
165
166
167
168
};

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

170
171
172
173
174
175
176
177
178
179
	.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},
180

181
182
183
184
185
186
187
188
189
190
	.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(18), .Type = DTYPE_String},
191

192
193
194
195
196
197
198
199
200
	.UnicodeString          = L"LUFA Joystick 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.
 */
201
202
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                    const uint8_t wIndex,
203
                                    const void** const DescriptorAddress)
204
205
206
207
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

208
209
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
210
211
212
213

	switch (DescriptorType)
	{
		case DTYPE_Device:
214
			Address = &DeviceDescriptor;
215
216
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
217
		case DTYPE_Configuration:
218
			Address = &ConfigurationDescriptor;
219
220
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
221
		case DTYPE_String:
222
223
			switch (DescriptorNumber)
			{
224
				case 0x00:
225
					Address = &LanguageString;
226
227
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
228
				case 0x01:
229
					Address = &ManufacturerString;
230
231
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
232
				case 0x02:
233
					Address = &ProductString;
234
235
236
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
237

238
			break;
239
		case DTYPE_HID:
240
			Address = &ConfigurationDescriptor.HID_JoystickHID;
241
			Size    = sizeof(USB_HID_Descriptor_HID_t);
242
			break;
243
		case DTYPE_Report:
244
			Address = &JoystickReport;
245
246
247
			Size    = sizeof(JoystickReport);
			break;
	}
248

249
250
251
	*DescriptorAddress = Address;
	return Size;
}
252