projects / pub / USBasp.git / blob
? search:


520d57d8a8f04442adeda657ba28bd3ce3ba3dc7
[pub/USBasp.git] / Demos / Device / ClassDriver / KeyboardMouse / Descriptors.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2009.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11 Copyright 2009 Denver Gingerich (denver [at] ossguy [dot] com)
12
13 Permission to use, copy, modify, and distribute this software
14 and its documentation for any purpose and without fee is hereby
15 granted, provided that the above copyright notice appear in all
16 copies and that both that the copyright notice and this
17 permission notice and warranty disclaimer appear in supporting
18 documentation, and that the name of the author not be used in
19 advertising or publicity pertaining to distribution of the
20 software without specific, written prior permission.
21
22 The author disclaim all warranties with regard to this
23 software, including all implied warranties of merchantability
24 and fitness. In no event shall the author be liable for any
25 special, indirect or consequential damages or any damages
26 whatsoever resulting from loss of use, data or profits, whether
27 in an action of contract, negligence or other tortious action,
28 arising out of or in connection with the use or performance of
29 this software.
30 */
31
32 /** \file
33 *
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 #include "Descriptors.h"
40
41 /** HID class report descriptor. This is a special descriptor constructed with values from the
42 * USBIF HID class specification to describe the reports and capabilities of the HID device. This
43 * descriptor is parsed by the host and its contents used to determine what data (and in what encoding)
44 * the device will send, and what it may be sent back from the host. Refer to the HID specification for
45 * more details on HID report descriptors.
46 *
47 * This descriptor describes the mouse HID interface's report structure.
48 */
49 USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
50 {
51 0x05, 0x01, /* Usage Page (Generic Desktop) */
52 0x09, 0x02, /* Usage (Mouse) */
53 0xA1, 0x01, /* Collection (Application) */
54 0x09, 0x01, /* Usage (Pointer) */
55 0xA1, 0x00, /* Collection (Physical) */
56 0x95, 0x03, /* Report Count (3) */
57 0x75, 0x01, /* Report Size (1) */
58 0x05, 0x09, /* Usage Page (Button) */
59 0x19, 0x01, /* Usage Minimum (Button 1) */
60 0x29, 0x03, /* Usage Maximum (Button 3) */
61 0x15, 0x00, /* Logical Minimum (0) */
62 0x25, 0x01, /* Logical Maximum (1) */
63 0x81, 0x02, /* Input (Data, Variable, Absolute) */
64 0x95, 0x01, /* Report Count (1) */
65 0x75, 0x05, /* Report Size (5) */
66 0x81, 0x01, /* Input (Constant) */
67 0x75, 0x08, /* Report Size (8) */
68 0x95, 0x02, /* Report Count (2) */
69 0x05, 0x01, /* Usage Page (Generic Desktop Control) */
70 0x09, 0x30, /* Usage X */
71 0x09, 0x31, /* Usage Y */
72 0x15, 0x81, /* Logical Minimum (-127) */
73 0x25, 0x7F, /* Logical Maximum (127) */
74 0x81, 0x06, /* Input (Data, Variable, Relative) */
75 0xC0, /* End Collection */
76 0xC0, /* End Collection */
77 };
78
79 /** Same as the MouseReport structure, but defines the keyboard HID interface's report structure. */
80 USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
81 {
82 0x05, 0x01, /* Usage Page (Generic Desktop) */
83 0x09, 0x06, /* Usage (Keyboard) */
84 0xa1, 0x01, /* Collection (Application) */
85 0x75, 0x01, /* Report Size (1) */
86 0x95, 0x08, /* Report Count (8) */
87 0x05, 0x07, /* Usage Page (Key Codes) */
88 0x19, 0xe0, /* Usage Minimum (Keyboard LeftControl) */
89 0x29, 0xe7, /* Usage Maximum (Keyboard Right GUI) */
90 0x15, 0x00, /* Logical Minimum (0) */
91 0x25, 0x01, /* Logical Maximum (1) */
92 0x81, 0x02, /* Input (Data, Variable, Absolute) */
93 0x95, 0x01, /* Report Count (1) */
94 0x75, 0x08, /* Report Size (8) */
95 0x81, 0x03, /* Input (Const, Variable, Absolute) */
96 0x95, 0x05, /* Report Count (5) */
97 0x75, 0x01, /* Report Size (1) */
98 0x05, 0x08, /* Usage Page (LEDs) */
99 0x19, 0x01, /* Usage Minimum (Num Lock) */
100 0x29, 0x05, /* Usage Maximum (Kana) */
101 0x91, 0x02, /* Output (Data, Variable, Absolute) */
102 0x95, 0x01, /* Report Count (1) */
103 0x75, 0x03, /* Report Size (3) */
104 0x91, 0x03, /* Output (Const, Variable, Absolute) */
105 0x95, 0x06, /* Report Count (6) */
106 0x75, 0x08, /* Report Size (8) */
107 0x15, 0x00, /* Logical Minimum (0) */
108 0x25, 0x65, /* Logical Maximum (101) */
109 0x05, 0x07, /* Usage Page (Keyboard) */
110 0x19, 0x00, /* Usage Minimum (Reserved (no event indicated)) */
111 0x29, 0x65, /* Usage Maximum (Keyboard Application) */
112 0x81, 0x00, /* Input (Data, Array, Absolute) */
113 0xC0 /* End Collection */
114 };
115
116 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
117 * device characteristics, including the supported USB version, control endpoint size and the
118 * number of device configurations. The descriptor is read out by the USB host when the enumeration
119 * process begins.
120 */
121 USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
122 {
123 .Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
124
125 .USBSpecification = VERSION_BCD(01.10),
126 .Class = 0x00,
127 .SubClass = 0x00,
128 .Protocol = 0x00,
129
130 .Endpoint0Size = FIXED_CONTROL_ENDPOINT_SIZE,
131
132 .VendorID = 0x03EB,
133 .ProductID = 0x204D,
134 .ReleaseNumber = 0x0000,
135
136 .ManufacturerStrIndex = 0x01,
137 .ProductStrIndex = 0x02,
138 .SerialNumStrIndex = NO_DESCRIPTOR,
139
140 .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
141 };
142
143 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
144 * of the device in one of its supported configurations, including information about any device interfaces
145 * and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
146 * a configuration so that the host may correctly communicate with the USB device.
147 */
148 USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
149 {
150 .Config =
151 {
152 .Header = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
153
154 .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
155 .TotalInterfaces = 2,
156
157 .ConfigurationNumber = 1,
158 .ConfigurationStrIndex = NO_DESCRIPTOR,
159
160 .ConfigAttributes = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
161
162 .MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
163 },
164
165 .KeyboardInterface =
166 {
167 .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
168
169 .InterfaceNumber = 0x00,
170 .AlternateSetting = 0x00,
171
172 .TotalEndpoints = 1,
173
174 .Class = 0x03,
175 .SubClass = 0x01,
176 .Protocol = HID_BOOT_KEYBOARD_PROTOCOL,
177
178 .InterfaceStrIndex = NO_DESCRIPTOR
179 },
180
181 .KeyboardHID =
182 {
183 .Header = {.Size = sizeof(USB_HID_Descriptor_t), .Type = DTYPE_HID},
184
185 .HIDSpec = VERSION_BCD(01.11),
186 .CountryCode = 0x00,
187 .TotalReportDescriptors = 1,
188 .HIDReportType = DTYPE_Report,
189 .HIDReportLength = sizeof(KeyboardReport)
190 },
191
192 .KeyboardInEndpoint =
193 {
194 .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
195
196 .EndpointAddress = (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_IN_EPNUM),
197 .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
198 .EndpointSize = HID_EPSIZE,
199 .PollingIntervalMS = 0x0A
200 },
201
202 .MouseInterface =
203 {
204 .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
205
206 .InterfaceNumber = 0x01,
207 .AlternateSetting = 0x00,
208
209 .TotalEndpoints = 1,
210
211 .Class = 0x03,
212 .SubClass = 0x01,
213 .Protocol = HID_BOOT_MOUSE_PROTOCOL,
214
215 .InterfaceStrIndex = NO_DESCRIPTOR
216 },
217
218 .MouseHID =
219 {
220 .Header = {.Size = sizeof(USB_HID_Descriptor_t), .Type = DTYPE_HID},
221
222 .HIDSpec = VERSION_BCD(01.11),
223 .CountryCode = 0x00,
224 .TotalReportDescriptors = 1,
225 .HIDReportType = DTYPE_Report,
226 .HIDReportLength = sizeof(MouseReport)
227 },
228
229 .MouseInEndpoint =
230 {
231 .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
232
233 .EndpointAddress = (ENDPOINT_DESCRIPTOR_DIR_IN | MOUSE_IN_EPNUM),
234 .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
235 .EndpointSize = HID_EPSIZE,
236 .PollingIntervalMS = 0x0A
237 }
238 };
239
240 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
241 * the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
242 * via the language ID table available at USB.org what languages the device supports for its string descriptors.
243 */
244 USB_Descriptor_String_t PROGMEM LanguageString =
245 {
246 .Header = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
247
248 .UnicodeString = {LANGUAGE_ID_ENG}
249 };
250
251 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
252 * form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
253 * Descriptor.
254 */
255 USB_Descriptor_String_t PROGMEM ManufacturerString =
256 {
257 .Header = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
258
259 .UnicodeString = L"Dean Camera"
260 };
261
262 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
263 * and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
264 * Descriptor.
265 */
266 USB_Descriptor_String_t PROGMEM ProductString =
267 {
268 .Header = {.Size = USB_STRING_LEN(28), .Type = DTYPE_String},
269
270 .UnicodeString = L"LUFA Mouse and Keyboard Demo"
271 };
272
273 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
274 * documentation) by the application code so that the address and size of a requested descriptor can be given
275 * to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
276 * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
277 * USB host.
278 */
279 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
280 {
281 const uint8_t DescriptorType = (wValue >> 8);
282 const uint8_t DescriptorNumber = (wValue & 0xFF);
283
284 void* Address = NULL;
285 uint16_t Size = NO_DESCRIPTOR;
286
287 switch (DescriptorType)
288 {
289 case DTYPE_Device:
290 Address = (void*)&DeviceDescriptor;
291 Size = sizeof(USB_Descriptor_Device_t);
292 break;
293 case DTYPE_Configuration:
294 Address = (void*)&ConfigurationDescriptor;
295 Size = sizeof(USB_Descriptor_Configuration_t);
296 break;
297 case DTYPE_String:
298 switch (DescriptorNumber)
299 {
300 case 0x00:
301 Address = (void*)&LanguageString;
302 Size = pgm_read_byte(&LanguageString.Header.Size);
303 break;
304 case 0x01:
305 Address = (void*)&ManufacturerString;
306 Size = pgm_read_byte(&ManufacturerString.Header.Size);
307 break;
308 case 0x02:
309 Address = (void*)&ProductString;
310 Size = pgm_read_byte(&ProductString.Header.Size);
311 break;
312 }
313
314 break;
315 case DTYPE_HID:
316 if (!(wIndex))
317 {
318 Address = (void*)&ConfigurationDescriptor.KeyboardHID;
319 Size = sizeof(USB_HID_Descriptor_t);
320 }
321 else
322 {
323 Address = (void*)&ConfigurationDescriptor.MouseHID;
324 Size = sizeof(USB_HID_Descriptor_t);
325 }
326 break;
327 case DTYPE_Report:
328 if (!(wIndex))
329 {
330 Address = (void*)&KeyboardReport;
331 Size = sizeof(KeyboardReport);
332 }
333 else
334 {
335 Address = (void*)&MouseReport;
336 Size = sizeof(MouseReport);
337 }
338
339 break;
340 }
341
342 *DescriptorAddress = Address;
343 return Size;
344 }
USB isp AVR programmer