Descriptors.c 7.38 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
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
 */

#include "Descriptors.h"


/** 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.
 */
46
const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
47
48
{
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
49

50
	.USBSpecification       = VERSION_BCD(01.10),
51
52
53
	.Class                  = USB_CSCP_NoDeviceClass,
	.SubClass               = USB_CSCP_NoDeviceSubclass,
	.Protocol               = USB_CSCP_NoDeviceProtocol,
54

55
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
56

57
58
	.VendorID               = 0x03EB,
	.ProductID              = 0x2045,
59
	.ReleaseNumber          = VERSION_BCD(00.01),
60

61
62
63
	.ManufacturerStrIndex   = 0x01,
	.ProductStrIndex        = 0x02,
	.SerialNumStrIndex      = USE_INTERNAL_SERIAL,
64

65
66
67
68
69
70
71
72
	.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.
 */
73
const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
74
{
75
	.Config =
76
77
78
79
80
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 1,
81

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

85
			.ConfigAttributes       = USB_CONFIG_ATTR_RESERVED,
86

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

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

			.InterfaceNumber        = 0,
			.AlternateSetting       = 0,
96

97
			.TotalEndpoints         = 2,
98

99
100
101
			.Class                  = MS_CSCP_MassStorageClass,
			.SubClass               = MS_CSCP_SCSITransparentSubclass,
			.Protocol               = MS_CSCP_BulkOnlyTransportProtocol,
102

103
104
105
			.InterfaceStrIndex      = NO_DESCRIPTOR
		},

106
	.MS_DataInEndpoint =
107
108
109
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

110
			.EndpointAddress        = MASS_STORAGE_IN_EPADDR,
111
112
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = MASS_STORAGE_IO_EPSIZE,
113
			.PollingIntervalMS      = 0x05
114
115
		},

116
	.MS_DataOutEndpoint =
117
118
119
		{
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

120
			.EndpointAddress        = MASS_STORAGE_OUT_EPADDR,
121
122
			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
			.EndpointSize           = MASS_STORAGE_IO_EPSIZE,
123
			.PollingIntervalMS      = 0x05
124
125
126
127
128
129
130
		}
};

/** 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.
 */
131
const USB_Descriptor_String_t PROGMEM LanguageString =
132
133
{
	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
134

135
136
137
138
139
140
141
	.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.
 */
142
const USB_Descriptor_String_t PROGMEM ManufacturerString =
143
144
{
	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
145

146
147
148
149
150
151
152
	.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.
 */
153
const USB_Descriptor_String_t PROGMEM ProductString =
154
155
{
	.Header                 = {.Size = USB_STRING_LEN(22), .Type = DTYPE_String},
156

157
158
159
160
161
162
163
164
165
	.UnicodeString          = L"LUFA Mass Storage Demo"
};

/** 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.
 */
166
167
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                                    const uint8_t wIndex,
168
                                    const void** const DescriptorAddress)
169
170
171
172
{
	const uint8_t  DescriptorType   = (wValue >> 8);
	const uint8_t  DescriptorNumber = (wValue & 0xFF);

173
174
	const void* Address = NULL;
	uint16_t    Size    = NO_DESCRIPTOR;
175
176
177

	switch (DescriptorType)
	{
178
		case DTYPE_Device:
179
			Address = &DeviceDescriptor;
180
181
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
182
		case DTYPE_Configuration:
183
			Address = &ConfigurationDescriptor;
184
185
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
186
		case DTYPE_String:
187
188
			switch (DescriptorNumber)
			{
189
				case 0x00:
190
					Address = &LanguageString;
191
192
					Size    = pgm_read_byte(&LanguageString.Header.Size);
					break;
193
				case 0x01:
194
					Address = &ManufacturerString;
195
196
					Size    = pgm_read_byte(&ManufacturerString.Header.Size);
					break;
197
				case 0x02:
198
					Address = &ProductString;
199
200
201
					Size    = pgm_read_byte(&ProductString.Header.Size);
					break;
			}
202

203
204
			break;
	}
205

206
207
208
	*DescriptorAddress = Address;
	return Size;
}
209