Descriptors.c 6.83 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2012.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
10
  Copyright 2012  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
  software without specific, written prior permission.

21
  The author disclaims all warranties with regard to this
22
23
24
25
26
27
28
29
30
31
32
  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
 */

#include "Descriptors.h"

40
/** Device descriptor structure. This descriptor, located in SRAM memory, describes the overall
41
42
43
44
 *  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                  = USB_CSCP_NoDeviceClass,
	.SubClass               = USB_CSCP_NoDeviceSubclass,
	.Protocol               = USB_CSCP_NoDeviceProtocol,
53

54
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
55

56
57
	.VendorID               = 0x03EB,
	.ProductID              = PRODUCT_ID_CODE,
58
	.ReleaseNumber          = VERSION_BCD(00.00),
59

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

64
65
66
	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
};

67
/** Configuration descriptor structure. This descriptor, located in SRAM memory, describes the usage
68
69
70
71
 *  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
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
77

78
79
			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 1,
80

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

84
			.ConfigAttributes       = USB_CONFIG_ATTR_RESERVED,
85

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

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

			.InterfaceNumber        = 0,
			.AlternateSetting       = 0,
95

96
			.TotalEndpoints         = 0,
97

98
99
100
101
102
103
			.Class                  = 0xFE,
			.SubClass               = 0x01,
			.Protocol               = 0x02,

			.InterfaceStrIndex      = NO_DESCRIPTOR
		},
104
105

	.DFU_Functional =
106
		{
107
			.Header                 = {.Size = sizeof(USB_Descriptor_DFU_Functional_t), .Type = DTYPE_DFUFunctional},
108

109
110
111
			.Attributes             = (ATTR_CAN_UPLOAD | ATTR_CAN_DOWNLOAD),

			.DetachTimeout          = 0x0000,
112
			.TransferSize           = 0x0C00,
113

114
			.DFUSpecification       = VERSION_BCD(01.10)
115
116
117
		}
};

118
/** Language descriptor structure. This descriptor, located in SRAM memory, is returned when the host requests
119
120
 *  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.
121
 */
122
const USB_Descriptor_String_t LanguageString =
123
124
{
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
125

126
127
128
	.UnicodeString          = {LANGUAGE_ID_ENG}
};

129
130
131
132
/** 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.
 */
133
const USB_Descriptor_String_t ManufacturerString =
134
135
136
137
138
139
{
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},

	.UnicodeString          = L"Dean Camera"
};

140
141
142
143
/** 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.
 */
144
const USB_Descriptor_String_t ProductString =
145
{
146
	.Header                 = {.Size = USB_STRING_LEN(8), .Type = DTYPE_String},
147

148
	.UnicodeString          = L"LUFA DFU"
149
150
151
152
153
154
155
156
};

/** This function is called by the library when in device mode, and must be overridden (see 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.
 */
157
158
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                    const uint8_t wIndex,
159
                                    const void** const DescriptorAddress)
160
{
161
162
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);
163

164
	const void* Address = NULL;
165
	uint16_t    Size    = NO_DESCRIPTOR;
166
167
168
169
170

	switch (DescriptorType)
	{
		case DTYPE_Device:
			Address = &DeviceDescriptor;
171
			Size    = sizeof(USB_Descriptor_Device_t);
172
			break;
173
		case DTYPE_Configuration:
174
			Address = &ConfigurationDescriptor;
175
			Size    = sizeof(USB_Descriptor_Configuration_t);
176
			break;
177
		case DTYPE_String:
178
			if (!(DescriptorNumber))
179
180
181
182
			{
				Address = &LanguageString;
				Size    = LanguageString.Header.Size;
			}
183
184
185
186
187
188
			else if (DescriptorNumber == 0x01)
			{
				Address = &ManufacturerString;
				Size    = ManufacturerString.Header.Size;
			}
			else if (DescriptorNumber == 0x02)
189
190
191
192
			{
				Address = &ProductString;
				Size    = ProductString.Header.Size;
			}
193

194
195
			break;
	}
196

197
	*DescriptorAddress = Address;
198
	return Size;
199
}
200