Statistics
| Branch: | Tag: | Revision:

root / Descriptors.c @ master

History | View | Annotate | Download (10 KB)

1 6ebafa20 imp
/*
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
  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
12

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
  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
const USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
48
{
49
        HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
50
        HID_RI_USAGE(8, 0x06), /* Keyboard */
51
        HID_RI_COLLECTION(8, 0x01), /* Application */
52
            HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
53
            HID_RI_USAGE_MINIMUM(8, 0xE0), /* Keyboard Left Control */
54
            HID_RI_USAGE_MAXIMUM(8, 0xE7), /* Keyboard Right GUI */
55
            HID_RI_LOGICAL_MINIMUM(8, 0x00),
56
            HID_RI_LOGICAL_MAXIMUM(8, 0x01),
57
            HID_RI_REPORT_SIZE(8, 0x01),
58
            HID_RI_REPORT_COUNT(8, 0x08),
59
            HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
60
            HID_RI_REPORT_COUNT(8, 0x01),
61
            HID_RI_REPORT_SIZE(8, 0x08),
62
            HID_RI_INPUT(8, HID_IOF_CONSTANT),
63
            HID_RI_USAGE_PAGE(8, 0x08), /* LEDs */
64
            HID_RI_USAGE_MINIMUM(8, 0x01), /* Num Lock */
65
            HID_RI_USAGE_MAXIMUM(8, 0x05), /* Kana */
66
            HID_RI_REPORT_COUNT(8, 0x05),
67
            HID_RI_REPORT_SIZE(8, 0x01),
68
            HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
69
            HID_RI_REPORT_COUNT(8, 0x01),
70
            HID_RI_REPORT_SIZE(8, 0x03),
71
            HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
72
            HID_RI_LOGICAL_MINIMUM(8, 0x00),
73
            HID_RI_LOGICAL_MAXIMUM(8, 0x65),
74
            HID_RI_USAGE_PAGE(8, 0x07), /* Keyboard */
75
            HID_RI_USAGE_MINIMUM(8, 0x00), /* Reserved (no event indicated) */
76
            HID_RI_USAGE_MAXIMUM(8, 0x65), /* Keyboard Application */
77
            HID_RI_REPORT_COUNT(8, 0x06),
78
            HID_RI_REPORT_SIZE(8, 0x08),
79
            HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
80
        HID_RI_END_COLLECTION(0),
81
};
82
83
/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
84
 *  device characteristics, including the supported USB version, control endpoint size and the
85
 *  number of device configurations. The descriptor is read out by the USB host when the enumeration
86
 *  process begins.
87
 */
88
const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
89
{
90
        .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
91
92
        .USBSpecification       = VERSION_BCD(01.10),
93
        .Class                  = USB_CSCP_NoDeviceClass,
94
        .SubClass               = USB_CSCP_NoDeviceSubclass,
95
        .Protocol               = USB_CSCP_NoDeviceProtocol,
96
97
        .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
98
99
        .VendorID               = 0x03EB,
100
        .ProductID              = 0x2042,
101
        .ReleaseNumber          = VERSION_BCD(00.01),
102
103
        .ManufacturerStrIndex   = 0x01,
104
        .ProductStrIndex        = 0x02,
105
        .SerialNumStrIndex      = NO_DESCRIPTOR,
106
107
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
108
};
109
110
/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
111
 *  of the device in one of its supported configurations, including information about any device interfaces
112
 *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
113
 *  a configuration so that the host may correctly communicate with the USB device.
114
 */
115
const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
116
{
117
        .Config =
118
                {
119
                        .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
120
121
                        .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
122
                        .TotalInterfaces        = 1,
123
124
                        .ConfigurationNumber    = 1,
125
                        .ConfigurationStrIndex  = NO_DESCRIPTOR,
126
127
                        .ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
128
129
                        .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
130
                },
131
132
        .HID_Interface =
133
                {
134
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
135
136
                        .InterfaceNumber        = 0x00,
137
                        .AlternateSetting       = 0x00,
138
139
                        .TotalEndpoints         = 2,
140
141
                        .Class                  = HID_CSCP_HIDClass,
142
                        .SubClass               = HID_CSCP_BootSubclass,
143
                        .Protocol               = HID_CSCP_KeyboardBootProtocol,
144
145
                        .InterfaceStrIndex      = NO_DESCRIPTOR
146
                },
147
148
        .HID_KeyboardHID =
149
                {
150
                        .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
151
152
                        .HIDSpec                = VERSION_BCD(01.11),
153
                        .CountryCode            = 0x00,
154
                        .TotalReportDescriptors = 1,
155
                        .HIDReportType          = HID_DTYPE_Report,
156
                        .HIDReportLength        = sizeof(KeyboardReport)
157
                },
158
159
        .HID_ReportINEndpoint =
160
                {
161
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
162
163
                        .EndpointAddress        = (ENDPOINT_DIR_IN | KEYBOARD_IN_EPNUM),
164
                        .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
165
                        .EndpointSize           = KEYBOARD_EPSIZE,
166
                        .PollingIntervalMS      = 0x01
167
                },
168
169
        .HID_ReportOUTEndpoint =
170
                {
171
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
172
173
                        .EndpointAddress        = (ENDPOINT_DIR_OUT | KEYBOARD_OUT_EPNUM),
174
                        .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
175
                        .EndpointSize           = KEYBOARD_EPSIZE,
176
                        .PollingIntervalMS      = 0x01
177
                }
178
};
179
180
/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
181
 *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
182
 *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
183
 */
184
const USB_Descriptor_String_t PROGMEM LanguageString =
185
{
186
        .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
187
188
        .UnicodeString          = {LANGUAGE_ID_ENG}
189
};
190
191
/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
192
 *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
193
 *  Descriptor.
194
 */
195
const USB_Descriptor_String_t PROGMEM ManufacturerString =
196
{
197
        .Header                 = {.Size = USB_STRING_LEN(8), .Type = DTYPE_String},
198
199
        .UnicodeString          = L"imp tech"
200
};
201
202
/** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
203
 *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
204
 *  Descriptor.
205
 */
206
const USB_Descriptor_String_t PROGMEM ProductString =
207
{
208
        .Header                 = {.Size = USB_STRING_LEN(10), .Type = DTYPE_String},
209
210
        .UnicodeString          = L"tasta v0.2"
211
};
212
213
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
214
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
215
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
216
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
217
 *  USB host.
218
 */
219
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
220
                                    const uint8_t wIndex,
221
                                    const void** const DescriptorAddress)
222
{
223
        const uint8_t  DescriptorType   = (wValue >> 8);
224
        const uint8_t  DescriptorNumber = (wValue & 0xFF);
225
226
        const void* Address = NULL;
227
        uint16_t    Size    = NO_DESCRIPTOR;
228
229
        switch (DescriptorType)
230
        {
231
                case DTYPE_Device:
232
                        Address = &DeviceDescriptor;
233
                        Size    = sizeof(USB_Descriptor_Device_t);
234
                        break;
235
                case DTYPE_Configuration:
236
                        Address = &ConfigurationDescriptor;
237
                        Size    = sizeof(USB_Descriptor_Configuration_t);
238
                        break;
239
                case DTYPE_String:
240
                        switch (DescriptorNumber)
241
                        {
242
                                case 0x00:
243
                                        Address = &LanguageString;
244
                                        Size    = pgm_read_byte(&LanguageString.Header.Size);
245
                                        break;
246
                                case 0x01:
247
                                        Address = &ManufacturerString;
248
                                        Size    = pgm_read_byte(&ManufacturerString.Header.Size);
249
                                        break;
250
                                case 0x02:
251
                                        Address = &ProductString;
252
                                        Size    = pgm_read_byte(&ProductString.Header.Size);
253
                                        break;
254
                        }
255
256
                        break;
257
                case HID_DTYPE_HID:
258
                        Address = &ConfigurationDescriptor.HID_KeyboardHID;
259
                        Size    = sizeof(USB_HID_Descriptor_HID_t);
260
                        break;
261
                case HID_DTYPE_Report:
262
                        Address = &KeyboardReport;
263
                        Size    = sizeof(KeyboardReport);
264
                        break;
265
        }
266
267
        *DescriptorAddress = Address;
268
        return Size;
269
}