USARTDescriptors.c 9.63 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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 */

#include "USARTDescriptors.h"

/* On some devices, there is a factory set internal serial number which can be automatically sent to the host as
 * the device's serial number when the Device Descriptor's .SerialNumStrIndex entry is set to USE_INTERNAL_SERIAL.
 * This allows the host to track a device across insertions on different ports, allowing them to retain allocated
 * resources like COM port numbers and drivers. On demos using this feature, give a warning on unsupported devices
 * so that the user can supply their own serial number descriptor instead or remove the USE_INTERNAL_SERIAL value
 * from the Device Descriptor (forcing the host to generate a serial number for each device from the VID, PID and
 * port location).
 */
#if (USE_INTERNAL_SERIAL == NO_DESCRIPTOR)
	#warning USE_INTERNAL_SERIAL is not available on this AVR - please manually construct a device serial descriptor.
#endif

/** Device descriptor structure. This descriptor, located in FLASH 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 PROGMEM USART_DeviceDescriptor =
{
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
60

61
	.USBSpecification       = VERSION_BCD(01.10),
62
63
64
	.Class                  = CDC_CSCP_CDCClass,
	.SubClass               = CDC_CSCP_NoSpecificSubclass,
	.Protocol               = CDC_CSCP_NoSpecificProtocol,
65

66
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
67

68
69
	.VendorID               = 0x03EB,
	.ProductID              = 0x204B,
70
	.ReleaseNumber          = VERSION_BCD(00.01),
71

72
73
74
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = USE_INTERNAL_SERIAL,
75

76
77
78
79
80
81
82
83
84
85
	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
};

/** Configuration descriptor structure. This descriptor, located in FLASH 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.
 */
USART_USB_Descriptor_Configuration_t PROGMEM USART_ConfigurationDescriptor =
{
86
	.Config =
87
88
89
90
91
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

			.TotalConfigurationSize = sizeof(USART_USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 2,
92

93
94
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
95

96
			.ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
97

98
99
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
		},
100
101

	.CDC_CCI_Interface =
102
103
104
105
106
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 0,
			.AlternateSetting       = 0,
107

108
			.TotalEndpoints         = 1,
109

110
111
112
			.Class                  = CDC_CSCP_CDCClass,
			.SubClass               = CDC_CSCP_ACMSubclass,
			.Protocol               = CDC_CSCP_ATCommandProtocol,
113

114
115
116
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

117
	.CDC_Functional_Header =
118
		{
119
120
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
			.Subtype                = CDC_DSUBTYPE_CSInterface_Header,
121

122
			.CDCSpecification       = VERSION_BCD(01.10),
123
124
		},

125
	.CDC_Functional_ACM =
126
		{
127
128
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
			.Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
129

130
			.Capabilities           = 0x06,
131
		},
132
133

	.CDC_Functional_Union =
134
		{
135
136
			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
			.Subtype                = CDC_DSUBTYPE_CSInterface_Union,
137

138
139
			.MasterInterfaceNumber  = 0,
			.SlaveInterfaceNumber   = 1,
140
141
		},

142
	.CDC_NotificationEndpoint =
143
144
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
145

146
147
148
149
150
151
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
			.PollingIntervalMS      = 0xFF
		},

152
	.CDC_DCI_Interface =
153
154
155
156
157
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

			.InterfaceNumber        = 1,
			.AlternateSetting       = 0,
158

159
			.TotalEndpoints         = 2,
160

161
162
163
			.Class                  = CDC_CSCP_CDCDataClass,
			.SubClass               = CDC_CSCP_NoDataSubclass,
			.Protocol               = CDC_CSCP_NoDataProtocol,
164

165
166
167
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

168
	.CDC_DataOutEndpoint =
169
170
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
171

172
173
174
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_TXRX_EPSIZE,
175
			.PollingIntervalMS      = 0x01
176
		},
177
178

	.CDC_DataInEndpoint =
179
180
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
181

182
183
184
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = CDC_TXRX_EPSIZE,
185
			.PollingIntervalMS      = 0x01
186
187
188
189
190
191
192
193
194
195
		}
};

/** Language descriptor structure. This descriptor, located in FLASH 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 PROGMEM USART_LanguageString =
{
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
196

197
198
199
200
201
202
203
204
205
206
	.UnicodeString          = {LANGUAGE_ID_ENG}
};

/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer'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 PROGMEM USART_ManufacturerString =
{
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
207

208
209
210
211
212
213
214
215
216
217
	.UnicodeString          = L"Dean Camera"
};

/** 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 PROGMEM USART_ProductString =
{
	.Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
218

219
220
221
	.UnicodeString          = L"LUFA XPLAIN Bridge"
};

222
/** Descriptor retrieval function for the USART Bridge descriptors. This function is in turn called by the GetDescriptor
223
224
 *  callback function in the main source file, to retrieve the device's descriptors when in USART bridge mode.
 */
225
226
uint16_t USART_GetDescriptor(const uint16_t wValue,
                             const uint8_t wIndex,
227
                             const void** const DescriptorAddress)
228
229
230
231
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

232
233
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
234
235
236

	switch (DescriptorType)
	{
237
		case DTYPE_Device:
238
			Address = &USART_DeviceDescriptor;
239
240
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
241
		case DTYPE_Configuration:
242
			Address = &USART_ConfigurationDescriptor;
243
244
			Size    = sizeof(USART_USB_Descriptor_Configuration_t);
			break;
245
		case DTYPE_String:
246
247
			switch (DescriptorNumber)
			{
248
				case 0x00:
249
					Address = &USART_LanguageString;
250
251
					Size    = pgm_read_byte(&USART_LanguageString.Header.Size);
					break;
252
				case 0x01:
253
					Address = &USART_ManufacturerString;
254
255
					Size    = pgm_read_byte(&USART_ManufacturerString.Header.Size);
					break;
256
				case 0x02:
257
					Address = &USART_ProductString;
258
259
260
					Size    = pgm_read_byte(&USART_ProductString.Header.Size);
					break;
			}
261

262
263
			break;
	}
264

265
266
267
	*DescriptorAddress = Address;
	return Size;
}
268