Descriptors.c 9.97 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, 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 
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
73
74
75
76
77
78
79
80
81
82
  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 MouseReport[] =
{
	0x05, 0x01,          /* Usage Page (Generic Desktop)             */
	0x09, 0x02,          /* Usage (Mouse)                            */
	0xA1, 0x01,          /* Collection (Application)                 */
	0x09, 0x01,          /*   Usage (Pointer)                        */
	0xA1, 0x00,          /*   Collection (Application)               */
	0x95, 0x03,          /*     Report Count (3)                     */
	0x75, 0x01,          /*     Report Size (1)                      */
	0x05, 0x09,          /*     Usage Page (Button)                  */
	0x19, 0x01,          /*     Usage Minimum (Button 1)             */
	0x29, 0x03,          /*     Usage Maximum (Button 3)             */
	0x15, 0x00,          /*     Logical Minimum (0)                  */
	0x25, 0x01,          /*     Logical Maximum (1)                  */
	0x81, 0x02,          /*     Input (Data, Variable, Absolute)     */
	0x95, 0x01,          /*     Report Count (1)                     */
	0x75, 0x05,          /*     Report Size (5)                      */
	0x81, 0x01,          /*     Input (Constant)                     */
	0x75, 0x08,          /*     Report Size (8)                      */
	0x95, 0x02,          /*     Report Count (2)                     */
	0x05, 0x01,          /*     Usage Page (Generic Desktop Control) */
	0x09, 0x30,          /*     Usage X                              */
	0x09, 0x31,          /*     Usage Y                              */
	0x15, 0x81,          /*     Logical Minimum (-127)               */
	0x25, 0x7F,          /*     Logical Maximum (127)                */
	0x81, 0x06,          /*     Input (Data, Variable, Relative)     */
	0xC0,                /*   End Collection                         */
	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 =
{
83
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
84
		
85
86
87
88
	.USBSpecification       = VERSION_BCD(01.10),
	.Class                  = 0x00,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
89
				
90
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
91
		
92
93
94
	.VendorID               = 0x03EB,
	.ProductID              = 0x2041,
	.ReleaseNumber          = 0x0000,
95
		
96
97
98
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
99
		
100
	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
101
102
103
104
105
106
107
108
109
};

/** 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 =
{
110
	.Config = 
111
		{
112
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
113

114
115
			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 1,
116
				
117
118
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
119
				
120
			.ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
121
			
122
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
123
124
		},
		
125
	.Interface = 
126
		{
127
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
128

129
130
			.InterfaceNumber        = 0x00,
			.AlternateSetting       = 0x00,
131
			
132
			.TotalEndpoints         = 1,
133
				
134
135
			.Class                  = 0x03,
			.SubClass               = 0x01,
136
			.Protocol               = HID_BOOT_MOUSE_PROTOCOL,
137
				
138
			.InterfaceStrIndex      = NO_DESCRIPTOR
139
140
		},

141
	.MouseHID = 
142
		{
143
			.Header                 = {.Size = sizeof(USB_HID_Descriptor_t), .Type = DTYPE_HID},
144

145
146
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
147
			.TotalReportDescriptors = 1,
148
149
			.HIDReportType          = DTYPE_Report,
			.HIDReportLength        = sizeof(MouseReport)
150
151
		},

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

156
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | MOUSE_EPNUM),
157
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
158
			.EndpointSize           = MOUSE_EPSIZE,
159
			.PollingIntervalMS      = 0x0A
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 =
{
169
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
170
		
171
	.UnicodeString          = {LANGUAGE_ID_ENG}
172
173
174
175
176
177
178
179
};

/** 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 =
{
180
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
181
		
182
	.UnicodeString          = L"Dean Camera"
183
184
185
186
187
188
189
190
};

/** 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 =
{
191
	.Header                 = {.Size = USB_STRING_LEN(15), .Type = DTYPE_String},
192
		
193
	.UnicodeString          = L"LUFA Mouse Demo"
194
195
};

196
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
197
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
198
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
199
200
201
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 *  USB host.
 */
202
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
203
204
205
206
207
208
209
210
211
212
{
	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:
213
			Address = (void*)&DeviceDescriptor;
214
215
216
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
		case DTYPE_Configuration:
217
			Address = (void*)&ConfigurationDescriptor;
218
219
220
221
222
223
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
		case DTYPE_String:
			switch (DescriptorNumber)
			{
				case 0x00:
224
					Address = (void*)&LanguageString;
225
226
227
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
				case 0x01:
228
					Address = (void*)&ManufacturerString;
229
230
231
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
				case 0x02:
232
					Address = (void*)&ProductString;
233
234
235
236
237
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
			
			break;
238
		case DTYPE_HID: 
239
			Address = (void*)&ConfigurationDescriptor.MouseHID;
240
			Size    = sizeof(USB_HID_Descriptor_t);
241
			break;
242
		case DTYPE_Report: 
243
			Address = (void*)&MouseReport;
244
245
246
247
248
249
250
251
			Size    = sizeof(MouseReport);
			break;
	}
	
	*DescriptorAddress = Address;		
	return Size;
}