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


71198e082e2f14798763af26ae59a35e2b9d7af3
[pub/USBasp.git] / Projects / Incomplete / StandaloneProgrammer / 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
12 Permission to use, copy, modify, and distribute this software
13 and its documentation for any purpose and without fee is hereby
14 granted, provided that the above copyright notice appear in all
15 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 disclaim 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 /* On some devices, there is a factory set internal serial number which can be automatically sent to the host as
41 * the device's serial number when the Device Descriptor's .SerialNumStrIndex entry is set to USE_INTERNAL_SERIAL.
42 * This allows the host to track a device across insertions on different ports, allowing them to retain allocated
43 * resources like COM port numbers and drivers. On demos using this feature, give a warning on unsupported devices
44 * so that the user can supply their own serial number descriptor instead or remove the USE_INTERNAL_SERIAL value
45 * from the Device Descriptor (forcing the host to generate a serial number for each device from the VID, PID and
46 * port location).
47 */
48 #if (USE_INTERNAL_SERIAL == NO_DESCRIPTOR)
49 #warning USE_INTERNAL_SERIAL is not available on this AVR - please manually construct a device serial descriptor.
50 #endif
51
52 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
53 * device characteristics, including the supported USB version, control endpoint size and the
54 * number of device configurations. The descriptor is read out by the USB host when the enumeration
55 * process begins.
56 */
57 USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
58 {
59 .Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
60
61 .USBSpecification = VERSION_BCD(01.10),
62 .Class = 0xEF,
63 .SubClass = 0x02,
64 .Protocol = 0x01,
65
66 .Endpoint0Size = FIXED_CONTROL_ENDPOINT_SIZE,
67
68 .VendorID = 0x03EB,
69 .ProductID = 0x2063,
70 .ReleaseNumber = 0x0000,
71
72 .ManufacturerStrIndex = 0x01,
73 .ProductStrIndex = 0x02,
74 .SerialNumStrIndex = USE_INTERNAL_SERIAL,
75
76 .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
77 };
78
79 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
80 * of the device in one of its supported configurations, including information about any device interfaces
81 * and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
82 * a configuration so that the host may correctly communicate with the USB device.
83 */
84 USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
85 {
86 .Config =
87 {
88 .Header = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
89
90 .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
91 .TotalInterfaces = 3,
92
93 .ConfigurationNumber = 1,
94 .ConfigurationStrIndex = NO_DESCRIPTOR,
95
96 .ConfigAttributes = USB_CONFIG_ATTR_BUSPOWERED,
97
98 .MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
99 },
100
101 .CDC_IAD =
102 {
103 .Header = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},
104
105 .FirstInterfaceIndex = 0,
106 .TotalInterfaces = 2,
107
108 .Class = 0x02,
109 .SubClass = 0x02,
110 .Protocol = 0x01,
111
112 .IADStrIndex = NO_DESCRIPTOR
113 },
114
115 .CCI_Interface =
116 {
117 .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
118
119 .InterfaceNumber = 0,
120 .AlternateSetting = 0,
121
122 .TotalEndpoints = 1,
123
124 .Class = 0x02,
125 .SubClass = 0x02,
126 .Protocol = 0x01,
127
128 .InterfaceStrIndex = NO_DESCRIPTOR
129 },
130
131 .CDC_Functional_IntHeader =
132 {
133 .Header = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
134 .SubType = 0x00,
135
136 .Data = {0x01, 0x10}
137 },
138
139 .CDC_Functional_CallManagement =
140 {
141 .Header = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
142 .SubType = 0x01,
143
144 .Data = {0x03, 0x01}
145 },
146
147 .CDC_Functional_AbstractControlManagement =
148 {
149 .Header = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
150 .SubType = 0x02,
151
152 .Data = {0x06}
153 },
154
155 .CDC_Functional_Union =
156 {
157 .Header = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
158 .SubType = 0x06,
159
160 .Data = {0x00, 0x01}
161 },
162
163 .ManagementEndpoint =
164 {
165 .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
166
167 .EndpointAddress = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
168 .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
169 .EndpointSize = CDC_NOTIFICATION_EPSIZE,
170 .PollingIntervalMS = 0xFF
171 },
172
173 .DCI_Interface =
174 {
175 .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
176
177 .InterfaceNumber = 1,
178 .AlternateSetting = 0,
179
180 .TotalEndpoints = 2,
181
182 .Class = 0x0A,
183 .SubClass = 0x00,
184 .Protocol = 0x00,
185
186 .InterfaceStrIndex = NO_DESCRIPTOR
187 },
188
189 .DataOutEndpoint =
190 {
191 .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
192
193 .EndpointAddress = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
194 .Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
195 .EndpointSize = CDC_TXRX_EPSIZE,
196 .PollingIntervalMS = 0x00
197 },
198
199 .DataInEndpoint =
200 {
201 .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
202
203 .EndpointAddress = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
204 .Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
205 .EndpointSize = CDC_TXRX_EPSIZE,
206 .PollingIntervalMS = 0x00
207 },
208
209 .MSInterface =
210 {
211 .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
212
213 .InterfaceNumber = 2,
214 .AlternateSetting = 0,
215
216 .TotalEndpoints = 2,
217
218 .Class = 0x08,
219 .SubClass = 0x06,
220 .Protocol = 0x50,
221
222 .InterfaceStrIndex = NO_DESCRIPTOR
223 },
224
225 .MSDataInEndpoint =
226 {
227 .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
228
229 .EndpointAddress = (ENDPOINT_DESCRIPTOR_DIR_IN | MASS_STORAGE_IN_EPNUM),
230 .Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
231 .EndpointSize = MASS_STORAGE_IO_EPSIZE,
232 .PollingIntervalMS = 0x00
233 },
234
235 .MSDataOutEndpoint =
236 {
237 .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
238
239 .EndpointAddress = (ENDPOINT_DESCRIPTOR_DIR_OUT | MASS_STORAGE_OUT_EPNUM),
240 .Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
241 .EndpointSize = MASS_STORAGE_IO_EPSIZE,
242 .PollingIntervalMS = 0x00
243 }
244 };
245
246 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
247 * the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
248 * via the language ID table available at USB.org what languages the device supports for its string descriptors.
249 */
250 USB_Descriptor_String_t PROGMEM LanguageString =
251 {
252 .Header = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
253
254 .UnicodeString = {LANGUAGE_ID_ENG}
255 };
256
257 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
258 * form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
259 * Descriptor.
260 */
261 USB_Descriptor_String_t PROGMEM ManufacturerString =
262 {
263 .Header = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
264
265 .UnicodeString = L"Dean Camera"
266 };
267
268 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
269 * and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
270 * Descriptor.
271 */
272 USB_Descriptor_String_t PROGMEM ProductString =
273 {
274 .Header = {.Size = USB_STRING_LEN(26), .Type = DTYPE_String},
275
276 .UnicodeString = L"LUFA Standalone Programmer"
277 };
278
279 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
280 * documentation) by the application code so that the address and size of a requested descriptor can be given
281 * to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
282 * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
283 * USB host.
284 */
285 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
286 {
287 const uint8_t DescriptorType = (wValue >> 8);
288 const uint8_t DescriptorNumber = (wValue & 0xFF);
289
290 void* Address = NULL;
291 uint16_t Size = NO_DESCRIPTOR;
292
293 switch (DescriptorType)
294 {
295 case DTYPE_Device:
296 Address = (void*)&DeviceDescriptor;
297 Size = sizeof(USB_Descriptor_Device_t);
298 break;
299 case DTYPE_Configuration:
300 Address = (void*)&ConfigurationDescriptor;
301 Size = sizeof(USB_Descriptor_Configuration_t);
302 break;
303 case DTYPE_String:
304 switch (DescriptorNumber)
305 {
306 case 0x00:
307 Address = (void*)&LanguageString;
308 Size = pgm_read_byte(&LanguageString.Header.Size);
309 break;
310 case 0x01:
311 Address = (void*)&ManufacturerString;
312 Size = pgm_read_byte(&ManufacturerString.Header.Size);
313 break;
314 case 0x02:
315 Address = (void*)&ProductString;
316 Size = pgm_read_byte(&ProductString.Header.Size);
317 break;
318 }
319
320 break;
321 }
322
323 *DescriptorAddress = Address;
324 return Size;
325 }
USB isp AVR programmer