Descriptors.c 7.2 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
47
  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[] =
{
48
49
50
51
52
53
54
55
56
57
58
59
60
61
	0x06, 0x9c, 0xff,        /* Usage Page (Vendor Defined)                     */
	0x09, TEENSY_USAGEPAGE,  /* Usage (Vendor Defined)                          */
	0xa1, 0x01,              /* Collection (Vendor Defined)                     */
	0x0a, 0x19, 0x00,        /*   Usage (Vendor Defined)                        */
	0x75, 0x08,              /*   Report Size (8)                               */
#if (SPM_PAGESIZE == 128)    /*   Report Count (SPM_PAGESIZE + 2)               */
	0x95, (SPM_PAGESIZE + 2)
#else
	0x96, ((SPM_PAGESIZE + 2) & 0xFF), ((SPM_PAGESIZE + 2) >> 8),
#endif
	0x15, 0x00,              /*   Logical Minimum (0)                           */
	0x25, 0xff,              /*   Logical Maximum (255)                         */
	0x91, 0x02,              /*   Output (Data, Variable, Absolute)             */
	0xc0                     /* End Collection                                  */
62
63
64
65
66
67
68
69
70
};

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

/** 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 =
{
98
	.Config = 
99
		{
100
			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
101

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

117
118
			.InterfaceNumber        = 0x00,
			.AlternateSetting       = 0x00,
119
			
120
			.TotalEndpoints         = 1,
121
				
122
123
124
			.Class                  = 0x03,
			.SubClass               = 0x00,
			.Protocol               = 0x00,
125
				
126
			.InterfaceStrIndex      = NO_DESCRIPTOR
127
128
		},

129
	.HID_VendorHID = 
130
		{  
131
			.Header                 = {.Size = sizeof(USB_Descriptor_HID_t), .Type = DTYPE_HID},
132
			
133
134
			.HIDSpec                = VERSION_BCD(01.11),
			.CountryCode            = 0x00,
135
			.TotalHIDDescriptors    = 1,
136
137
			.HIDReportType          = DTYPE_Report,
			.HIDReportLength        = sizeof(HIDReport)
138
139
		},
		
140
	.HID_ReportINEndpoint = 
141
		{
142
			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
143

144
			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | HID_EPNUM),
145
			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
146
147
			.EndpointSize           = HID_EPSIZE,
			.PollingIntervalMS      = 0x40
148
149
150
		},
};

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

	void*    Address = NULL;
	uint16_t Size    = NO_DESCRIPTOR;

164
165
166
167
168
169
170
	/* If/Else If chain compiles slightly smaller than a switch case */

	if (DescriptorType == DTYPE_Device)
	{
		Address = (void*)&DeviceDescriptor;
		Size    = sizeof(USB_Descriptor_Device_t);	
	}
171
	else if (DescriptorType == DTYPE_Configuration)
172
173
174
175
176
177
178
179
180
181
	{
		Address = (void*)&ConfigurationDescriptor;
		Size    = sizeof(USB_Descriptor_Configuration_t);	
	}
	else if (DescriptorType == DTYPE_HID)
	{
		Address = (void*)&ConfigurationDescriptor.HID_VendorHID;
		Size    = sizeof(USB_Descriptor_HID_t);
	}
	else
182
	{
183
184
		Address = (void*)&HIDReport;
		Size    = sizeof(HIDReport);
185
	}
186

187
188
189
	*DescriptorAddress = Address;
	return Size;
}