3 Copyright (C) Dean Camera, 2014.
5 dean [at] fourwalledcubicle [dot] com
10 Copyright 2014 Dean Camera (dean [at] fourwalledcubicle [dot] com)
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 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
21 The author disclaims all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
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.
38 #include "Descriptors.h"
40 /** HID class report descriptor. This is a special descriptor constructed with values from the
41 * USBIF HID class specification to describe the reports and capabilities of the HID device. This
42 * descriptor is parsed by the host and its contents used to determine what data (and in what encoding)
43 * the device will send, and what it may be sent back from the host. Refer to the HID specification for
44 * more details on HID report descriptors.
46 const USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
48 HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
49 HID_RI_USAGE(8, 0x02), /* Mouse */
50 HID_RI_COLLECTION(8, 0x01), /* Application */
51 HID_RI_USAGE(8, 0x01), /* Pointer */
52 HID_RI_COLLECTION(8, 0x00), /* Physical */
53 HID_RI_USAGE_PAGE(8, 0x09), /* Button */
54 HID_RI_USAGE_MINIMUM(8, 0x01),
55 HID_RI_USAGE_MAXIMUM(8, 0x03),
56 HID_RI_LOGICAL_MINIMUM(8, 0x00),
57 HID_RI_LOGICAL_MAXIMUM(8, 0x01),
58 HID_RI_REPORT_COUNT(8, 0x03),
59 HID_RI_REPORT_SIZE(8, 0x01),
60 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
61 HID_RI_REPORT_COUNT(8, 0x01),
62 HID_RI_REPORT_SIZE(8, 0x05),
63 HID_RI_INPUT(8, HID_IOF_CONSTANT),
64 HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
65 HID_RI_USAGE(8, 0x30), /* Usage X */
66 HID_RI_USAGE(8, 0x31), /* Usage Y */
67 HID_RI_LOGICAL_MINIMUM(8, -1),
68 HID_RI_LOGICAL_MAXIMUM(8, 1),
69 HID_RI_PHYSICAL_MINIMUM(8, -1),
70 HID_RI_PHYSICAL_MAXIMUM(8, 1),
71 HID_RI_REPORT_COUNT(8, 0x02),
72 HID_RI_REPORT_SIZE(8, 0x08),
73 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
74 HID_RI_END_COLLECTION(0),
75 HID_RI_END_COLLECTION(0),
78 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
79 * device characteristics, including the supported USB version, control endpoint size and the
80 * number of device configurations. The descriptor is read out by the USB host when the enumeration
83 const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
85 .Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
87 .USBSpecification = VERSION_BCD(1,1,0),
88 .Class = USB_CSCP_NoDeviceClass,
89 .SubClass = USB_CSCP_NoDeviceSubclass,
90 .Protocol = USB_CSCP_NoDeviceProtocol,
92 .Endpoint0Size = FIXED_CONTROL_ENDPOINT_SIZE,
96 .ReleaseNumber = VERSION_BCD(0,0,1),
98 .ManufacturerStrIndex = STRING_ID_Manufacturer,
99 .ProductStrIndex = STRING_ID_Product,
100 .SerialNumStrIndex = NO_DESCRIPTOR,
102 .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
105 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
106 * of the device in one of its supported configurations, including information about any device interfaces
107 * and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
108 * a configuration so that the host may correctly communicate with the USB device.
110 const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
114 .Header = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
116 .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
117 .TotalInterfaces = 1,
119 .ConfigurationNumber = 1,
120 .ConfigurationStrIndex = NO_DESCRIPTOR,
122 .ConfigAttributes = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
124 .MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
129 .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
131 .InterfaceNumber = INTERFACE_ID_Mouse,
132 .AlternateSetting = 0x00,
136 .Class = HID_CSCP_HIDClass,
137 .SubClass = HID_CSCP_BootSubclass,
138 .Protocol = HID_CSCP_MouseBootProtocol,
140 .InterfaceStrIndex = NO_DESCRIPTOR
145 .Header = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
147 .HIDSpec = VERSION_BCD(1,1,1),
149 .TotalReportDescriptors = 1,
150 .HIDReportType = HID_DTYPE_Report,
151 .HIDReportLength = sizeof(MouseReport)
154 .HID_ReportINEndpoint =
156 .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
158 .EndpointAddress = MOUSE_EPADDR,
159 .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
160 .EndpointSize = MOUSE_EPSIZE,
161 .PollingIntervalMS = 0x05
165 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
166 * the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
167 * via the language ID table available at USB.org what languages the device supports for its string descriptors.
169 const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
171 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
172 * form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
175 const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"Dean Camera");
177 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
178 * and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
181 const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA Mouse Demo");
183 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
184 * documentation) by the application code so that the address and size of a requested descriptor can be given
185 * to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
186 * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
189 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
190 const uint8_t wIndex,
191 const void** const DescriptorAddress)
193 const uint8_t DescriptorType = (wValue >> 8);
194 const uint8_t DescriptorNumber = (wValue & 0xFF);
196 const void* Address = NULL;
197 uint16_t Size = NO_DESCRIPTOR;
199 switch (DescriptorType)
202 Address = &DeviceDescriptor;
203 Size = sizeof(USB_Descriptor_Device_t);
205 case DTYPE_Configuration:
206 Address = &ConfigurationDescriptor;
207 Size = sizeof(USB_Descriptor_Configuration_t);
210 switch (DescriptorNumber)
212 case STRING_ID_Language:
213 Address = &LanguageString;
214 Size = pgm_read_byte(&LanguageString.Header.Size);
216 case STRING_ID_Manufacturer:
217 Address = &ManufacturerString;
218 Size = pgm_read_byte(&ManufacturerString.Header.Size);
220 case STRING_ID_Product:
221 Address = &ProductString;
222 Size = pgm_read_byte(&ProductString.Header.Size);
228 Address = &ConfigurationDescriptor.HID_MouseHID;
229 Size = sizeof(USB_HID_Descriptor_HID_t);
231 case HID_DTYPE_Report:
232 Address = &MouseReport;
233 Size = sizeof(MouseReport);
237 *DescriptorAddress = Address;