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    permission notice and warranty disclaimer appear in supporting
 17    documentation, and that the name of the author not be used in
 18    advertising or publicity pertaining to distribution of the
 19    software without specific, written prior permission.
 20  
 21    The author disclaim all warranties with regard to this
 22    software, including all implied warranties of merchantability
 23    and fitness.  In no event shall the author be liable for any
 24    special, indirect or consequential damages or any damages
 25    whatsoever resulting from loss of use, data or profits, whether
 26    in an action of contract, negligence or other tortious action,
 27    arising out of or in connection with the use or performance of
 28    this software.
 29  */
 30  
 31  /** \file
 32   *
 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  #include "Descriptors.h"
 39  
 40  /** Device descriptor structure. This descriptor, located in SRAM memory, describes the overall
 41   *  device characteristics, including the supported USB version, control endpoint size and the
 42   *  number of device configurations. The descriptor is read out by the USB host when the enumeration
 43   *  process begins.
 44   */
 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  	.Class                  = CDC_CSCP_CDCClass,
 51  	.SubClass               = CDC_CSCP_NoSpecificSubclass,
 52  	.Protocol               = CDC_CSCP_NoSpecificProtocol,
 53  
 54  	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
 55  
 56  	.VendorID               = DEVICE_VID,
 57  	.ProductID              = DEVICE_PID,
 58  	.ReleaseNumber          = VERSION_BCD(00.01),
 59  
 60  	.ManufacturerStrIndex   = 0x02,
 61  	.ProductStrIndex        = 0x01,
 62  	.SerialNumStrIndex      = NO_DESCRIPTOR,
 63  
 64  	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 65  };
 66  
 67  /** Configuration descriptor structure. This descriptor, located in SRAM memory, describes the usage
 68   *  of the device in one of its supported configurations, including information about any device interfaces
 69   *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
 70   *  a configuration so that the host may correctly communicate with the USB device.
 71   */
 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  			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
 79  			.TotalInterfaces        = 2,
 80  
 81  			.ConfigurationNumber    = 1,
 82  			.ConfigurationStrIndex  = NO_DESCRIPTOR,
 83  
 84  			.ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
 85  
 86  			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 87  		},
 88  
 89  	.CDC_CCI_Interface =
 90  		{
 91  			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 92  
 93  			.InterfaceNumber        = 0,
 94  			.AlternateSetting       = 0,
 95  
 96  			.TotalEndpoints         = 1,
 97  
 98  			.Class                  = CDC_CSCP_CDCClass,
 99  			.SubClass               = CDC_CSCP_ACMSubclass,
100  			.Protocol               = CDC_CSCP_ATCommandProtocol,
101  
102  			.InterfaceStrIndex      = NO_DESCRIPTOR
103  		},
104  
105  	.CDC_Functional_Header =
106  		{
107  			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
108  			.Subtype                = 0x00,
109  
110  			.CDCSpecification       = VERSION_BCD(01.10),
111  		},
112  
113  	.CDC_Functional_ACM =
114  		{
115  			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
116  			.Subtype                = 0x02,
117  
118  			.Capabilities           = 0x04,
119  		},
120  
121  	.CDC_Functional_Union =
122  		{
123  			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
124  			.Subtype                = 0x06,
125  
126  			.MasterInterfaceNumber  = 0,
127  			.SlaveInterfaceNumber   = 1,
128  		},
129  
130  	.CDC_NotificationEndpoint =
131  		{
132  			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
133  
134  			.EndpointAddress        = (ENDPOINT_DIR_IN | CDC_NOTIFICATION_EPNUM),
135  			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
136  			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
137  			.PollingIntervalMS      = 0xFF
138  		},
139  
140  	.CDC_DCI_Interface =
141  		{
142  			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
143  
144  			.InterfaceNumber        = 1,
145  			.AlternateSetting       = 0,
146  
147  			.TotalEndpoints         = 2,
148  
149  			.Class                  = CDC_CSCP_CDCDataClass,
150  			.SubClass               = CDC_CSCP_NoDataSubclass,
151  			.Protocol               = CDC_CSCP_NoDataProtocol,
152  
153  			.InterfaceStrIndex      = NO_DESCRIPTOR
154  		},
155  
156  	.CDC_DataOutEndpoint =
157  		{
158  			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
159  
160  			.EndpointAddress        = (ENDPOINT_DIR_OUT | CDC_RX_EPNUM),
161  			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
162  			.EndpointSize           = CDC_TXRX_EPSIZE,
163  			.PollingIntervalMS      = 0x01
164  		},
165  
166  	.CDC_DataInEndpoint =
167  		{
168  			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
169  
170  			.EndpointAddress        = (ENDPOINT_DIR_IN | CDC_TX_EPNUM),
171  			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
172  			.EndpointSize           = CDC_TXRX_EPSIZE,
173  			.PollingIntervalMS      = 0x01
174  		}
175  };
176  
177  /** Language descriptor structure. This descriptor, located in SRAM memory, is returned when the host requests
178   *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
179   *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
180   */
181  const USB_Descriptor_String_t LanguageString =
182  {
183  	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
184  
185  	.UnicodeString          = {LANGUAGE_ID_ENG}
186  };
187  
188  /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
189   *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
190   *  Descriptor.
191   */
192  const USB_Descriptor_String_t ProductString =
193  {
194  	.Header                 = {.Size = USB_STRING_LEN(16), .Type = DTYPE_String},
195  
196  	#if DEVICE_PID == 0x0036
197  	.UnicodeString          = L"Arduino Leonardo" 
198  	#elif DEVICE_PID == 0x0037
199  	.UnicodeString			= L"Arduino Micro   "
200  	#elif DEVICE_PID == 0x003C
201  	.UnicodeString			= L"Arduino Esplora "
202  	#else
203  	.UnicodeString			= L"USB IO board    "
204  	#endif
205  };
206  
207  const USB_Descriptor_String_t ManufNameString = 
208  {
209  	.Header					= {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
210  	
211  	#if DEVICE_VID == 0x2341
212  	.UnicodeString			= L"Arduino LLC"
213  	#else
214  	.UnicodeString			= L"Unknown    "
215  	#endif
216  };
217  
218  /** This function is called by the library when in device mode, and must be overridden (see LUFA library "USB Descriptors"
219   *  documentation) by the application code so that the address and size of a requested descriptor can be given
220   *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
221   *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
222   *  USB host.
223   */
224  uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
225                                      const uint8_t wIndex,
226                                      const void** const DescriptorAddress)
227  {
228  	const uint8_t  DescriptorType   = (wValue >> 8);
229  	const uint8_t  DescriptorNumber = (wValue & 0xFF);
230  
231  	const void* Address = NULL;
232  	uint16_t    Size    = NO_DESCRIPTOR;
233  
234  	switch (DescriptorType)
235  	{
236  		case DTYPE_Device:
237  			Address = &DeviceDescriptor;
238  			Size    = sizeof(USB_Descriptor_Device_t);
239  			break;
240  		case DTYPE_Configuration:
241  			Address = &ConfigurationDescriptor;
242  			Size    = sizeof(USB_Descriptor_Configuration_t);
243  			break;
244  		case DTYPE_String:
245  			if (!(DescriptorNumber))
246  			{
247  				Address = &LanguageString;
248  				Size    = LanguageString.Header.Size;
249  			}
250  			else if (DescriptorNumber == DeviceDescriptor.ProductStrIndex) 
251  			{
252  				Address = &ProductString;
253  				Size    = ProductString.Header.Size;
254  			} else if (DescriptorNumber == DeviceDescriptor.ManufacturerStrIndex)
255  			{
256  				Address = &ManufNameString;
257  				Size	= ManufNameString.Header.Size;
258  			}
259  
260  			break;
261  	}
262  
263  	*DescriptorAddress = Address;
264  	return Size;
265  }
266