Descriptors.c 8.2 KB
Newer Older
1 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

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 17 18
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
19 20 21 22 23 24 25 26 27 28 29 30 31 32
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
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 39 40 41 42 43 44
 */

#include "Descriptors.h"

/** Device descriptor structure. This descriptor, located in SRAM memory, describes the overall
 *  device characteristics, including the supported USB version, control endpoint size and the
 *  number of device configurations. The descriptor is read out by the USB host when the enumeration
 *  process begins.
 */
45
const USB_Descriptor_Device_t DeviceDescriptor =
46 47
{
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
48

49
	.USBSpecification       = VERSION_BCD(01.10),
50 51 52
	.Class                  = CDC_CSCP_CDCClass,
	.SubClass               = CDC_CSCP_NoSpecificSubclass,
	.Protocol               = CDC_CSCP_NoSpecificProtocol,
53

54
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
55

56 57
	.VendorID               = 0x03EB,
	.ProductID              = 0x204A,
58
	.ReleaseNumber          = VERSION_BCD(00.01),
59

60 61 62
	.ManufacturerStrIndex   = NO_DESCRIPTOR,
	.ProductStrIndex        = 0x01,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
63

64 65 66 67 68 69 70 71
	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
};

/** Configuration descriptor structure. This descriptor, located in SRAM memory, describes the usage
 *  of the device in one of its supported configurations, including information about any device interfaces
 *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
 *  a configuration so that the host may correctly communicate with the USB device.
 */
72
const USB_Descriptor_Configuration_t ConfigurationDescriptor =
73
{
74
	.Config =
75 76 77 78 79
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 2,
80

81 82
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
83

84
			.ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
85

86 87
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
		},
88 89

	.CDC_CCI_Interface =
90 91 92 93 94
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 0,
			.AlternateSetting       = 0,
95

96
			.TotalEndpoints         = 1,
97

98 99 100
			.Class                  = CDC_CSCP_CDCClass,
			.SubClass               = CDC_CSCP_ACMSubclass,
			.Protocol               = CDC_CSCP_ATCommandProtocol,
101

102 103 104
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

105
	.CDC_Functional_Header =
106
		{
107
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
108
			.Subtype                = 0x00,
109

110
			.CDCSpecification       = VERSION_BCD(01.10),
111 112
		},

113
	.CDC_Functional_ACM =
114
		{
115
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
116
			.Subtype                = 0x02,
117

118
			.Capabilities           = 0x06,
119
		},
120 121

	.CDC_Functional_Union =
122
		{
123
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
124
			.Subtype                = 0x06,
125

126 127 128
			.MasterInterfaceNumber  = 0,
			.SlaveInterfaceNumber   = 1,
		},
129

130
	.CDC_NotificationEndpoint =
131 132
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
133

134
			.EndpointAddress        = (ENDPOINT_DIR_IN | CDC_NOTIFICATION_EPNUM),
135 136
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
137
			.PollingIntervalMS      = 0xFF
138 139
		},

140
	.CDC_DCI_Interface =
141 142 143 144 145
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 1,
			.AlternateSetting       = 0,
146

147
			.TotalEndpoints         = 2,
148

149 150 151
			.Class                  = CDC_CSCP_CDCDataClass,
			.SubClass               = CDC_CSCP_NoDataSubclass,
			.Protocol               = CDC_CSCP_NoDataProtocol,
152

153 154 155
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

156
	.CDC_DataOutEndpoint =
157 158
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
159

160
			.EndpointAddress        = (ENDPOINT_DIR_OUT | CDC_RX_EPNUM),
161 162
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_TXRX_EPSIZE,
163
			.PollingIntervalMS      = 0x01
164
		},
165 166

	.CDC_DataInEndpoint =
167 168
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
169

170
			.EndpointAddress        = (ENDPOINT_DIR_IN | CDC_TX_EPNUM),
171 172
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_TXRX_EPSIZE,
173
			.PollingIntervalMS      = 0x01
174 175 176 177 178 179 180
		}
};

/** Language descriptor structure. This descriptor, located in SRAM memory, is returned when the host requests
 *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 */
181
const USB_Descriptor_String_t LanguageString =
182 183
{
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
184

185 186 187 188 189 190 191
	.UnicodeString          = {LANGUAGE_ID_ENG}
};

/** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 *  Descriptor.
 */
192
const USB_Descriptor_String_t ProductString =
193 194
{
	.Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
195

196 197 198 199 200 201 202 203 204
	.UnicodeString          = L"AVR CDC Bootloader"
};

/** This function is called by the library when in device mode, and must be overridden (see LUFA library "USB Descriptors"
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 *  USB host.
 */
205 206
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                    const uint8_t wIndex,
207
                                    const void** const DescriptorAddress)
208
{
209 210
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);
211

212
	const void* Address = NULL;
213
	uint16_t    Size    = NO_DESCRIPTOR;
214 215 216 217

	switch (DescriptorType)
	{
		case DTYPE_Device:
218
			Address = &DeviceDescriptor;
219
			Size    = sizeof(USB_Descriptor_Device_t);
220 221
			break;
		case DTYPE_Configuration:
222
			Address = &ConfigurationDescriptor;
223
			Size    = sizeof(USB_Descriptor_Configuration_t);
224 225 226
			break;
		case DTYPE_String:
			if (!(DescriptorNumber))
227 228 229 230
			{
				Address = &LanguageString;
				Size    = LanguageString.Header.Size;
			}
231
			else
232 233 234 235
			{
				Address = &ProductString;
				Size    = ProductString.Header.Size;
			}
236

237 238
			break;
	}
239

240
	*DescriptorAddress = Address;
241
	return Size;
242
}
243