diff options
| author | Dean Camera <[email protected]> | 2010-01-19 05:27:58 +0000 | 
|---|---|---|
| committer | Dean Camera <[email protected]> | 2010-01-19 05:27:58 +0000 | 
| commit | 60fd0ff418566d85224f9841037ba01b77acc0d8 (patch) | |
| tree | c97d59c17a21b467c0fe0c989437c2ff9fcae5a2 /Projects/XPLAINBridge/USARTDescriptors.c | |
| parent | 27461546523862a3a76ee41f615f7ec2eed2195f (diff) | |
| download | qmk_firmware-60fd0ff418566d85224f9841037ba01b77acc0d8.tar.gz qmk_firmware-60fd0ff418566d85224f9841037ba01b77acc0d8.zip | |
Changed XPLAINBridge project to be both a USB to USART bridge and a PDI programmer, based on the state of a mode select pin.
Diffstat (limited to 'Projects/XPLAINBridge/USARTDescriptors.c')
| -rw-r--r-- | Projects/XPLAINBridge/USARTDescriptors.c | 269 | 
1 files changed, 269 insertions, 0 deletions
| diff --git a/Projects/XPLAINBridge/USARTDescriptors.c b/Projects/XPLAINBridge/USARTDescriptors.c new file mode 100644 index 0000000000..d8587f2b2f --- /dev/null +++ b/Projects/XPLAINBridge/USARTDescriptors.c @@ -0,0 +1,269 @@ +/*
 +             LUFA Library
 +     Copyright (C) Dean Camera, 2010.
 +              
 +  dean [at] fourwalledcubicle [dot] com
 +      www.fourwalledcubicle.com
 +*/
 +
 +/*
 +  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 +
 +  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 
 +  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 "USARTDescriptors.h"
 +
 +/* On some devices, there is a factory set internal serial number which can be automatically sent to the host as
 + * the device's serial number when the Device Descriptor's .SerialNumStrIndex entry is set to USE_INTERNAL_SERIAL.
 + * This allows the host to track a device across insertions on different ports, allowing them to retain allocated
 + * resources like COM port numbers and drivers. On demos using this feature, give a warning on unsupported devices
 + * so that the user can supply their own serial number descriptor instead or remove the USE_INTERNAL_SERIAL value
 + * from the Device Descriptor (forcing the host to generate a serial number for each device from the VID, PID and
 + * port location).
 + */
 +#if (USE_INTERNAL_SERIAL == NO_DESCRIPTOR)
 +	#warning USE_INTERNAL_SERIAL is not available on this AVR - please manually construct a device serial descriptor.
 +#endif
 +
 +/** 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 PROGMEM USART_DeviceDescriptor =
 +{
 +	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
 +		
 +	.USBSpecification       = VERSION_BCD(01.10),
 +	.Class                  = 0x02,
 +	.SubClass               = 0x00,
 +	.Protocol               = 0x00,
 +				
 +	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
 +		
 +	.VendorID               = 0x03EB,
 +	.ProductID              = 0x204B,
 +	.ReleaseNumber          = 0x0000,
 +		
 +	.ManufacturerStrIndex   = 0x01,
 +	.ProductStrIndex        = 0x02,
 +	.SerialNumStrIndex      = USE_INTERNAL_SERIAL,
 +		
 +	.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.
 + */
 +USART_USB_Descriptor_Configuration_t PROGMEM USART_ConfigurationDescriptor =
 +{
 +	.Config = 
 +		{
 +			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 +
 +			.TotalConfigurationSize = sizeof(USART_USB_Descriptor_Configuration_t),
 +			.TotalInterfaces        = 2,
 +				
 +			.ConfigurationNumber    = 1,
 +			.ConfigurationStrIndex  = NO_DESCRIPTOR,
 +				
 +			.ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
 +			
 +			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 +		},
 +		
 +	.CCI_Interface = 
 +		{
 +			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 +
 +			.InterfaceNumber        = 0,
 +			.AlternateSetting       = 0,
 +			
 +			.TotalEndpoints         = 1,
 +				
 +			.Class                  = 0x02,
 +			.SubClass               = 0x02,
 +			.Protocol               = 0x01,
 +				
 +			.InterfaceStrIndex      = NO_DESCRIPTOR
 +		},
 +
 +	.CDC_Functional_IntHeader = 
 +		{
 +			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 +			.SubType                = 0x00,
 +			
 +			.Data                   = {0x01, 0x10}
 +		},
 +
 +	.CDC_Functional_CallManagement = 
 +		{
 +			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 +			.SubType                = 0x01,
 +			
 +			.Data                   = {0x03, 0x01}
 +		},
 +
 +	.CDC_Functional_AbstractControlManagement = 
 +		{
 +			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
 +			.SubType                = 0x02,
 +			
 +			.Data                   = {0x06}
 +		},
 +		
 +	.CDC_Functional_Union= 
 +		{
 +			.Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 +			.SubType                = 0x06,
 +			
 +			.Data                   = {0x00, 0x01}
 +		},
 +
 +	.ManagementEndpoint = 
 +		{
 +			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 +			
 +			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
 +			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 +			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 +			.PollingIntervalMS      = 0xFF
 +		},
 +
 +	.DCI_Interface = 
 +		{
 +			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 +
 +			.InterfaceNumber        = 1,
 +			.AlternateSetting       = 0,
 +			
 +			.TotalEndpoints         = 2,
 +				
 +			.Class                  = 0x0A,
 +			.SubClass               = 0x00,
 +			.Protocol               = 0x00,
 +				
 +			.InterfaceStrIndex      = NO_DESCRIPTOR
 +		},
 +
 +	.DataOutEndpoint = 
 +		{
 +			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 +			
 +			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
 +			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 +			.EndpointSize           = CDC_TXRX_EPSIZE,
 +			.PollingIntervalMS      = 0x00
 +		},
 +		
 +	.DataInEndpoint = 
 +		{
 +			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 +			
 +			.EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
 +			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 +			.EndpointSize           = CDC_TXRX_EPSIZE,
 +			.PollingIntervalMS      = 0x00
 +		}
 +};
 +
 +/** 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.
 + */
 +USB_Descriptor_String_t PROGMEM USART_LanguageString =
 +{
 +	.Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 +		
 +	.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.
 + */
 +USB_Descriptor_String_t PROGMEM USART_ManufacturerString =
 +{
 +	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 +		
 +	.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.
 + */
 +USB_Descriptor_String_t PROGMEM USART_ProductString =
 +{
 +	.Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
 +		
 +	.UnicodeString          = L"LUFA XPLAIN Bridge"
 +};
 +
 +uint16_t USART_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 +{
 +	const uint8_t  DescriptorType   = (wValue >> 8);
 +	const uint8_t  DescriptorNumber = (wValue & 0xFF);
 +
 +	void*    Address = NULL;
 +	uint16_t Size    = NO_DESCRIPTOR;
 +
 +	switch (DescriptorType)
 +	{
 +		case DTYPE_Device: 
 +			Address = (void*)&USART_DeviceDescriptor;
 +			Size    = sizeof(USB_Descriptor_Device_t);
 +			break;
 +		case DTYPE_Configuration: 
 +			Address = (void*)&USART_ConfigurationDescriptor;
 +			Size    = sizeof(USART_USB_Descriptor_Configuration_t);
 +			break;
 +		case DTYPE_String: 
 +			switch (DescriptorNumber)
 +			{
 +				case 0x00: 
 +					Address = (void*)&USART_LanguageString;
 +					Size    = pgm_read_byte(&USART_LanguageString.Header.Size);
 +					break;
 +				case 0x01: 
 +					Address = (void*)&USART_ManufacturerString;
 +					Size    = pgm_read_byte(&USART_ManufacturerString.Header.Size);
 +					break;
 +				case 0x02: 
 +					Address = (void*)&USART_ProductString;
 +					Size    = pgm_read_byte(&USART_ProductString.Header.Size);
 +					break;
 +			}
 +			
 +			break;
 +	}
 +	
 +	*DescriptorAddress = Address;
 +	return Size;
 +}
 | 
