Descriptors.c 6.99 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
	  
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
47
48
  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"

/** HID class report descriptor. This is a special descriptor constructed with values from the
 *  USBIF HID class specification to describe the reports and capabilities of the HID device. This
 *  descriptor is parsed by the host and its contents used to determine what data (and in what encoding)
 *  the device will send, and what it may be sent back from the host. Refer to the HID specification for
 *  more details on HID report descriptors.
 */
USB_Descriptor_HIDReport_Datatype_t HIDReport[] =
{
	0x06, 0x9c, 0xff,     /* Usage Page (Vendor Defined)                     */
49
	0x09, 0x1B,           /* Usage (Vendor Defined)                          */
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
	0xa1, 0x01,           /* Collection (Vendor Defined)                     */
	0x0a, 0x19, 0x00,     /*   Usage (Vendor Defined)                        */
	0x75, 0x08,           /*   Report Size (8)                               */
	0x95, 0x82,           /*   Report Count (130)                            */
	0x15, 0x00,           /*   Logical Minimum (0)                           */
	0x25, 0xff,           /*   Logical Maximum (255)                         */
	0x91, 0x02,           /*   Output (Data, Variable, Absolute)             */
	0xc0                  /* End Collection                                  */
};

/** 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 DeviceDescriptor =
{
67
	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
68
		
69
70
71
72
	.USBSpecification       = VERSION_BCD(01.10),
	.Class                  = 0x00,
	.SubClass               = 0x00,
	.Protocol               = 0x00,
73
				
74
	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
75
		
76
77
	.VendorID               = 0x16C0,
	.ProductID              = 0x0478,
78
	.ReleaseNumber          = 0x0120,
79
		
80
	.ManufacturerStrIndex   = NO_DESCRIPTOR,
81
	.ProductStrIndex        = NO_DESCRIPTOR,
82
	.SerialNumStrIndex      = NO_DESCRIPTOR,
83
		
84
	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
85
86
87
88
89
90
91
92
93
};

/** 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.
 */
USB_Descriptor_Configuration_t ConfigurationDescriptor =
{
94
	.Config = 
95
		{
96
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
97

98
99
			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
			.TotalInterfaces        = 1,
100
				
101
102
			.ConfigurationNumber    = 1,
			.ConfigurationStrIndex  = NO_DESCRIPTOR,
103
				
104
			.ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
105
			
106
			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
107
108
		},
		
109
	.Interface = 
110
		{
111
			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
112

113
114
			.InterfaceNumber        = 0x00,
			.AlternateSetting       = 0x00,
115
			
116
			.TotalEndpoints         = 1,
117
				
118
119
120
			.Class                  = 0x03,
			.SubClass               = 0x00,
			.Protocol               = 0x00,
121
				
122
			.InterfaceStrIndex      = NO_DESCRIPTOR
123
124
		},

125
	.HIDDescriptor = 
126
		{  
127
			.Header                 = {.Size = sizeof(USB_Descriptor_HID_t), .Type = DTYPE_HID},
128
			
129
130
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
131
			.TotalHIDDescriptors    = 1,
132
133
			.HIDReportType          = DTYPE_Report,
			.HIDReportLength        = sizeof(HIDReport)
134
135
		},
		
136
	.HIDEndpoint = 
137
		{
138
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
139

140
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | HID_EPNUM),
141
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
142
143
			.EndpointSize           = HID_EPSIZE,
			.PollingIntervalMS      = 0x40
144
145
146
		},
};

147
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
148
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
149
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
150
151
152
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 *  USB host.
 */
153
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
154
{
155
	const uint8_t DescriptorType = (wValue >> 8);
156
157
158
159
160
161
162

	void*    Address = NULL;
	uint16_t Size    = NO_DESCRIPTOR;

	switch (DescriptorType)
	{
		case DTYPE_Device:
163
			Address = (void*)&DeviceDescriptor;
164
165
166
			Size    = sizeof(USB_Descriptor_Device_t);
			break;
		case DTYPE_Configuration:
167
			Address = (void*)&ConfigurationDescriptor;
168
169
170
			Size    = sizeof(USB_Descriptor_Configuration_t);
			break;
		case DTYPE_HID:
171
			Address = (void*)&ConfigurationDescriptor.HIDDescriptor;
172
173
174
			Size    = sizeof(USB_Descriptor_HID_t);
			break;
		case DTYPE_Report:
175
			Address = (void*)&HIDReport;
176
177
178
179
180
181
182
			Size    = sizeof(HIDReport);
			break;
	}
	
	*DescriptorAddress = Address;
	return Size;
}