Descriptors.c 9.37 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, provided that the above copyright notice appear in all
  copies and that both that the copyright notice and this
  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
  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
 *
 *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special 
 *  computer-readable structures which the host requests upon device enumeration, to determine
 *  the device's capabilities and functions.  
 */

#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 GenericReport[] =
{
	0x06, 0x9c, 0xff,     /* Usage Page (Vendor Defined)                     */
	0x09, 0x01,           /* Usage (Vendor Defined)                          */
	0xa1, 0x01,           /* Collection (Vendor Defined)                     */
	0x09, 0x02,           /*   Usage (Vendor Defined)                        */
	0x75, 0x08,           /*   Report Size (8)                               */
	0x95, GENERIC_REPORT_SIZE, /*   Report Count (GENERIC_REPORT_SIZE)       */
	0x15, 0x00,           /*   Logical Minimum (0)                           */
	0x25, 0xff,           /*   Logical Maximum (255)                         */
	0x81, 0x02,           /*   Input (Data, Variable, Absolute)              */
	0x09, 0x03,           /*   Usage (Vendor Defined)                        */
	0x75, 0x08,           /*   Report Size (8)                               */
	0x95, GENERIC_REPORT_SIZE, /*   Report Count (GENERIC_REPORT_SIZE)       */
	0x15, 0x00,           /*   Logical Minimum (0)                           */
	0x25, 0xff,           /*   Logical Maximum (255)                         */
	0x91, 0x02,           /*   Output (Data, Variable, Absolute)             */
	0xc0                  /* End Collection                                  */
};

/** 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 =
{
73
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
74
		
75
76
77
78
	.USBSpecification       = VERSION_BCD(01.10),
	.Class                  = 0x00,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
79
				
80
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
81
		
82
83
84
	.VendorID               = 0x03EB,
	.ProductID              = 0x204F,
	.ReleaseNumber          = 0x0000,
85
		
86
87
88
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
89
		
90
	.NumberOfConfigurations = 1
91
92
93
94
95
96
97
98
99
};

/** 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 =
{
100
	.Config = 
101
		{
102
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
103

104
105
			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 1,
106
				
107
108
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
109
				
110
			.ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
111
			
112
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
113
114
		},
		
115
	.Interface = 
116
		{
117
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
118

119
120
			.InterfaceNumber        = 0x00,
			.AlternateSetting       = 0x00,
121
			
122
			.TotalEndpoints         = 1,
123
				
124
125
126
			.Class                  = 0x03,
			.SubClass               = 0x00,
			.Protocol               = 0x00,
127
				
128
			.InterfaceStrIndex      = NO_DESCRIPTOR
129
130
		},

131
	.GenericHID = 
132
		{
133
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_t), .Type = DTYPE_HID},
134
									 
135
136
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
137
			.TotalReportDescriptors = 1,
138
139
			.HIDReportType          = DTYPE_Report,
			.HIDReportLength        = sizeof(GenericReport)
140
141
		},

142
	.GenericINEndpoint = 
143
		{
144
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
145
										 
146
147
148
149
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | GENERIC_IN_EPNUM),
			.Attributes             = EP_TYPE_INTERRUPT,
			.EndpointSize           = GENERIC_EPSIZE,
			.PollingIntervalMS      = 0x02
150
151
152
153
154
155
156
157
158
		},
};

/** 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 =
{
159
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
160
		
161
	.UnicodeString          = {LANGUAGE_ID_ENG}
162
163
164
165
166
167
168
169
};

/** 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 =
{
170
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
171
		
172
	.UnicodeString          = L"Dean Camera"
173
174
175
176
177
178
179
180
};

/** 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 =
{
181
	.Header                 = {.Size = USB_STRING_LEN(21), .Type = DTYPE_String},
182
		
183
	.UnicodeString          = L"LUFA Generic HID Demo"
184
185
};

186
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
187
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
188
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
189
190
191
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 *  USB host.
 */
192
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
193
194
195
196
197
198
199
200
201
202
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

	void*    Address = NULL;
	uint16_t Size    = NO_DESCRIPTOR;

	switch (DescriptorType)
	{
		case DTYPE_Device:
203
			Address = (void*)&DeviceDescriptor;
204
205
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
206
		case DTYPE_Configuration: 
207
			Address = (void*)&ConfigurationDescriptor;
208
209
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
210
		case DTYPE_String: 
211
212
			switch (DescriptorNumber)
			{
213
				case 0x00: 
214
					Address = (void*)&LanguageString;
215
216
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
217
				case 0x01: 
218
					Address = (void*)&ManufacturerString;
219
220
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
221
				case 0x02: 
222
					Address = (void*)&ProductString;
223
224
225
226
227
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
			
			break;
228
		case DTYPE_HID: 
229
			Address = (void*)&ConfigurationDescriptor.GenericHID;
230
			Size    = sizeof(USB_HID_Descriptor_t);
231
			break;
232
		case DTYPE_Report: 
233
			Address = (void*)&GenericReport;
234
235
236
237
238
239
240
			Size    = sizeof(GenericReport);
			break;
	}
	
	*DescriptorAddress = Address;
	return Size;
}