1 | /*
|
---|
2 | LUFA Library
|
---|
3 | Copyright (C) Dean Camera, 2021.
|
---|
4 |
|
---|
5 | dean [at] fourwalledcubicle [dot] com
|
---|
6 | www.lufa-lib.org
|
---|
7 | */
|
---|
8 |
|
---|
9 | /*
|
---|
10 | Copyright 2021 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
---|
11 |
|
---|
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.
|
---|
20 |
|
---|
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
|
---|
28 | this software.
|
---|
29 | */
|
---|
30 |
|
---|
31 | /** \file
|
---|
32 | *
|
---|
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.
|
---|
36 | */
|
---|
37 |
|
---|
38 | #include "Descriptors.h"
|
---|
39 |
|
---|
40 | /** Device descriptor structure. This descriptor, located in SRAM memory, describes the overall
|
---|
41 | * device characteristics, including the supported USB version, control endpoint size and the
|
---|
42 | * number of device configurations. The descriptor is read out by the USB host when the enumeration
|
---|
43 | * process begins.
|
---|
44 | */
|
---|
45 | const USB_Descriptor_Device_t DeviceDescriptor =
|
---|
46 | {
|
---|
47 | .Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
|
---|
48 |
|
---|
49 | .USBSpecification = VERSION_BCD(1,1,0),
|
---|
50 | .Class = USB_CSCP_NoDeviceClass,
|
---|
51 | .SubClass = USB_CSCP_NoDeviceSubclass,
|
---|
52 | .Protocol = USB_CSCP_NoDeviceProtocol,
|
---|
53 |
|
---|
54 | .Endpoint0Size = FIXED_CONTROL_ENDPOINT_SIZE,
|
---|
55 |
|
---|
56 | .VendorID = 0x03EB,
|
---|
57 | .ProductID = PRODUCT_ID_CODE,
|
---|
58 | .ReleaseNumber = VERSION_BCD(0,0,0),
|
---|
59 |
|
---|
60 | .ManufacturerStrIndex = STRING_ID_Manufacturer,
|
---|
61 | .ProductStrIndex = STRING_ID_Product,
|
---|
62 | .SerialNumStrIndex = NO_DESCRIPTOR,
|
---|
63 |
|
---|
64 | .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
|
---|
65 | };
|
---|
66 |
|
---|
67 | /** Configuration descriptor structure. This descriptor, located in SRAM memory, describes the usage
|
---|
68 | * of the device in one of its supported configurations, including information about any device interfaces
|
---|
69 | * and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
|
---|
70 | * a configuration so that the host may correctly communicate with the USB device.
|
---|
71 | */
|
---|
72 | const USB_Descriptor_Configuration_t ConfigurationDescriptor =
|
---|
73 | {
|
---|
74 | .Config =
|
---|
75 | {
|
---|
76 | .Header = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
|
---|
77 |
|
---|
78 | .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
|
---|
79 | .TotalInterfaces = 1,
|
---|
80 |
|
---|
81 | .ConfigurationNumber = 1,
|
---|
82 | .ConfigurationStrIndex = NO_DESCRIPTOR,
|
---|
83 |
|
---|
84 | .ConfigAttributes = USB_CONFIG_ATTR_RESERVED,
|
---|
85 |
|
---|
86 | .MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
|
---|
87 | },
|
---|
88 |
|
---|
89 | .DFU_Interface =
|
---|
90 | {
|
---|
91 | .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
|
---|
92 |
|
---|
93 | .InterfaceNumber = INTERFACE_ID_DFU,
|
---|
94 | .AlternateSetting = 0,
|
---|
95 |
|
---|
96 | .TotalEndpoints = 0,
|
---|
97 |
|
---|
98 | .Class = 0xFE,
|
---|
99 | .SubClass = 0x01,
|
---|
100 | .Protocol = 0x02,
|
---|
101 |
|
---|
102 | .InterfaceStrIndex = NO_DESCRIPTOR
|
---|
103 | },
|
---|
104 |
|
---|
105 | .DFU_Functional =
|
---|
106 | {
|
---|
107 | .Header = {.Size = sizeof(USB_Descriptor_DFU_Functional_t), .Type = DTYPE_DFUFunctional},
|
---|
108 |
|
---|
109 | .Attributes = (ATTR_CAN_UPLOAD | ATTR_CAN_DOWNLOAD),
|
---|
110 |
|
---|
111 | .DetachTimeout = 0x0000,
|
---|
112 | .TransferSize = 0x0C00,
|
---|
113 |
|
---|
114 | .DFUSpecification = VERSION_BCD(1,1,0)
|
---|
115 | }
|
---|
116 | };
|
---|
117 |
|
---|
118 | /** Language descriptor structure. This descriptor, located in SRAM memory, is returned when the host requests
|
---|
119 | * the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
|
---|
120 | * via the language ID table available at USB.org what languages the device supports for its string descriptors.
|
---|
121 | */
|
---|
122 | const USB_Descriptor_String_t LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
|
---|
123 |
|
---|
124 | /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
|
---|
125 | * form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
|
---|
126 | * Descriptor.
|
---|
127 | */
|
---|
128 | const USB_Descriptor_String_t ManufacturerString = USB_STRING_DESCRIPTOR(L"LUFA Library");
|
---|
129 |
|
---|
130 | /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
|
---|
131 | * and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
|
---|
132 | * Descriptor.
|
---|
133 | */
|
---|
134 | const USB_Descriptor_String_t ProductString = USB_STRING_DESCRIPTOR(L"LUFA DFU");
|
---|
135 |
|
---|
136 | /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
|
---|
137 | * documentation) by the application code so that the address and size of a requested descriptor can be given
|
---|
138 | * to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
|
---|
139 | * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
|
---|
140 | * USB host.
|
---|
141 | */
|
---|
142 | uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
|
---|
143 | const uint16_t wIndex,
|
---|
144 | const void** const DescriptorAddress)
|
---|
145 | {
|
---|
146 | const uint8_t DescriptorType = (wValue >> 8);
|
---|
147 | const uint8_t DescriptorNumber = (wValue & 0xFF);
|
---|
148 |
|
---|
149 | const void* Address = NULL;
|
---|
150 | uint16_t Size = NO_DESCRIPTOR;
|
---|
151 |
|
---|
152 | switch (DescriptorType)
|
---|
153 | {
|
---|
154 | case DTYPE_Device:
|
---|
155 | Address = &DeviceDescriptor;
|
---|
156 | Size = sizeof(USB_Descriptor_Device_t);
|
---|
157 | break;
|
---|
158 | case DTYPE_Configuration:
|
---|
159 | Address = &ConfigurationDescriptor;
|
---|
160 | Size = sizeof(USB_Descriptor_Configuration_t);
|
---|
161 | break;
|
---|
162 | case DTYPE_String:
|
---|
163 | if (DescriptorNumber == STRING_ID_Language)
|
---|
164 | {
|
---|
165 | Address = &LanguageString;
|
---|
166 | Size = LanguageString.Header.Size;
|
---|
167 | }
|
---|
168 | else if (DescriptorNumber == STRING_ID_Manufacturer)
|
---|
169 | {
|
---|
170 | Address = &ManufacturerString;
|
---|
171 | Size = ManufacturerString.Header.Size;
|
---|
172 | }
|
---|
173 | else if (DescriptorNumber == STRING_ID_Product)
|
---|
174 | {
|
---|
175 | Address = &ProductString;
|
---|
176 | Size = ProductString.Header.Size;
|
---|
177 | }
|
---|
178 |
|
---|
179 | break;
|
---|
180 | }
|
---|
181 |
|
---|
182 | *DescriptorAddress = Address;
|
---|
183 | return Size;
|
---|
184 | }
|
---|
185 |
|
---|