Descriptors.c 8.28 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
  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
 *
 *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special 
 *  computer-readable structures which the host requests upon device enumeration, to determine
 *  the device's capabilities and functions.  
 */

#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.
 */
USB_Descriptor_Device_t DeviceDescriptor =
{
47
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
48
		
49
50
51
52
	.USBSpecification       = VERSION_BCD(01.10),
	.Class                  = 0x02,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
53
				
54
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
55
		
56
57
58
	.VendorID               = 0x03EB,
	.ProductID              = 0x204A,
	.ReleaseNumber          = 0x0000,
59
		
60
61
62
	.ManufacturerStrIndex   = NO_DESCRIPTOR,
	.ProductStrIndex        = 0x01,
	.SerialNumStrIndex      = NO_DESCRIPTOR,
63
		
64
	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
65
66
67
68
69
70
71
72
73
};

/** 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.
 */
USB_Descriptor_Configuration_t ConfigurationDescriptor =
{
74
	.Config = 
75
		{
76
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
77

78
79
			.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
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
87
88
		},
		
89
	.CDC_CCI_Interface = 
90
		{
91
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
92

93
94
			.InterfaceNumber        = 0,
			.AlternateSetting       = 0,
95
			
96
			.TotalEndpoints         = 1,
97
				
98
99
100
			.Class                  = 0x02,
			.SubClass               = 0x02,
			.Protocol               = 0x01,
101
				
102
			.InterfaceStrIndex      = NO_DESCRIPTOR
103
104
		},

105
	.CDC_Functional_IntHeader = 
106
		{
107
108
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x00,
109
			
110
			.Data                   = {0x10, 0x01}
111
112
		},

113
	.CDC_Functional_AbstractControlManagement = 
114
		{
115
116
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
			.SubType                = 0x02,
117
			
118
			.Data                   = {0x06}
119
120
		},
		
121
	.CDC_Functional_Union = 
122
		{
123
124
			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
			.SubType                = 0x06,
125
			
126
			.Data                   = {0x00, 0x01}
127
128
		},	

129
	.CDC_ManagementEndpoint = 
130
		{
131
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
132
										 
133
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
134
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
135
136
			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
			.PollingIntervalMS      = 0x02
137
138
		},

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

143
144
			.InterfaceNumber        = 1,
			.AlternateSetting       = 0,
145
			
146
			.TotalEndpoints         = 2,
147
				
148
149
150
			.Class                  = 0x0A,
			.SubClass               = 0x00,
			.Protocol               = 0x00,
151
				
152
			.InterfaceStrIndex      = NO_DESCRIPTOR
153
154
		},

155
	.CDC_DataOutEndpoint = 
156
		{
157
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
158
										 
159
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
160
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
161
162
			.EndpointSize           = CDC_TXRX_EPSIZE,
			.PollingIntervalMS      = 0x00
163
164
		},
		
165
	.CDC_DataInEndpoint = 
166
		{
167
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
168
										 
169
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
170
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
171
172
			.EndpointSize           = CDC_TXRX_EPSIZE,
			.PollingIntervalMS      = 0x00
173
174
175
176
177
178
179
180
181
		}
};

/** 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.
 */
USB_Descriptor_String_t LanguageString =
{
182
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
183
		
184
	.UnicodeString          = {LANGUAGE_ID_ENG}
185
186
187
188
189
190
191
192
};

/** 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.
 */
USB_Descriptor_String_t ProductString =
{
193
	.Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
194
		
195
	.UnicodeString          = L"AVR CDC Bootloader"
196
197
};

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

	void*    Address = NULL;
	uint16_t Size    = NO_DESCRIPTOR;

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