3
Copyright (C) Dean Camera, 2012.
5
dean [at] fourwalledcubicle [dot] com
10
Copyright 2012 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 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
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"
41
/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
42
* device characteristics, including the supported USB version, control endpoint size and the
43
* number of device configurations. The descriptor is read out by the USB host when the enumeration
46
const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
48
.Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
50
.USBSpecification = VERSION_BCD(01.10),
51
.Class = CDC_CSCP_CDCClass,
52
.SubClass = CDC_CSCP_NoSpecificSubclass,
53
.Protocol = CDC_CSCP_NoSpecificProtocol,
55
.Endpoint0Size = FIXED_CONTROL_ENDPOINT_SIZE,
59
.ReleaseNumber = VERSION_BCD(00.01),
61
.ManufacturerStrIndex = 0x01,
62
.ProductStrIndex = 0x02,
63
.SerialNumStrIndex = USE_INTERNAL_SERIAL,
65
.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
68
/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
69
* of the device in one of its supported configurations, including information about any device interfaces
70
* and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
71
* a configuration so that the host may correctly communicate with the USB device.
73
const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
77
.Header = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
79
.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
82
.ConfigurationNumber = 1,
83
.ConfigurationStrIndex = NO_DESCRIPTOR,
85
.ConfigAttributes = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
87
.MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
92
.Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
95
.AlternateSetting = 0,
99
.Class = CDC_CSCP_CDCClass,
100
.SubClass = CDC_CSCP_ACMSubclass,
101
.Protocol = CDC_CSCP_ATCommandProtocol,
103
.InterfaceStrIndex = NO_DESCRIPTOR
106
.CDC_Functional_Header =
108
.Header = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
109
.Subtype = CDC_DSUBTYPE_CSInterface_Header,
111
.CDCSpecification = VERSION_BCD(01.10),
114
.CDC_Functional_ACM =
116
.Header = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
117
.Subtype = CDC_DSUBTYPE_CSInterface_ACM,
119
.Capabilities = 0x06,
122
.CDC_Functional_Union =
124
.Header = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
125
.Subtype = CDC_DSUBTYPE_CSInterface_Union,
127
.MasterInterfaceNumber = 0,
128
.SlaveInterfaceNumber = 1,
131
.CDC_NotificationEndpoint =
133
.Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
135
.EndpointAddress = CDC_NOTIFICATION_EPADDR,
136
.Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
137
.EndpointSize = CDC_NOTIFICATION_EPSIZE,
138
.PollingIntervalMS = 0xFF
143
.Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
145
.InterfaceNumber = 1,
146
.AlternateSetting = 0,
150
.Class = CDC_CSCP_CDCDataClass,
151
.SubClass = CDC_CSCP_NoDataSubclass,
152
.Protocol = CDC_CSCP_NoDataProtocol,
154
.InterfaceStrIndex = NO_DESCRIPTOR
157
.CDC_DataOutEndpoint =
159
.Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
161
.EndpointAddress = CDC_RX_EPADDR,
162
.Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
163
.EndpointSize = CDC_TXRX_EPSIZE,
164
.PollingIntervalMS = 0x05
167
.CDC_DataInEndpoint =
169
.Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
171
.EndpointAddress = CDC_TX_EPADDR,
172
.Attributes = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
173
.EndpointSize = CDC_TXRX_EPSIZE,
174
.PollingIntervalMS = 0x05
178
/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
179
* the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
180
* via the language ID table available at USB.org what languages the device supports for its string descriptors.
182
const USB_Descriptor_String_t PROGMEM LanguageString =
184
.Header = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
186
.UnicodeString = {LANGUAGE_ID_ENG}
189
/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
190
* form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
193
const USB_Descriptor_String_t PROGMEM ManufacturerString =
195
.Header = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
197
.UnicodeString = L"Dean Camera"
200
/** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
201
* and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
204
const USB_Descriptor_String_t PROGMEM ProductString =
206
.Header = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},
208
.UnicodeString = L"LUFA CDC Demo"
211
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
212
* documentation) by the application code so that the address and size of a requested descriptor can be given
213
* to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
214
* is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
217
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
218
const uint8_t wIndex,
219
const void** const DescriptorAddress)
221
const uint8_t DescriptorType = (wValue >> 8);
222
const uint8_t DescriptorNumber = (wValue & 0xFF);
224
const void* Address = NULL;
225
uint16_t Size = NO_DESCRIPTOR;
227
switch (DescriptorType)
230
Address = &DeviceDescriptor;
231
Size = sizeof(USB_Descriptor_Device_t);
233
case DTYPE_Configuration:
234
Address = &ConfigurationDescriptor;
235
Size = sizeof(USB_Descriptor_Configuration_t);
238
switch (DescriptorNumber)
241
Address = &LanguageString;
242
Size = pgm_read_byte(&LanguageString.Header.Size);
245
Address = &ManufacturerString;
246
Size = pgm_read_byte(&ManufacturerString.Header.Size);
249
Address = &ProductString;
250
Size = pgm_read_byte(&ProductString.Header.Size);
257
*DescriptorAddress = Address;