added example for dual serial port

git-svn-id: https://svn.spreadspace.org/avr/trunk@190 aa12f405-d877-488e-9caf-2d797e2a1cc7

2 files changed, 504 insertions, 0 deletions

diff --git a/lib/lufa-descriptor-usbdualserial.c b/lib/lufa-descriptor-usbdualserial.c
new file mode 100644
index 0000000..5a5750a
--- /dev/null
+++ b/lib/lufa-descriptor-usbdualserial.c
@@ -0,0 +1,392 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2012.

+

+  dean [at] fourwalledcubicle [dot] com

+           www.lufa-lib.org

+*/

+

+/*

+  Copyright 2012  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 "lufa-descriptor-usbdualserial.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.

+ */

+const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =

+{

+	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},

+

+	.USBSpecification       = VERSION_BCD(01.10),

+	.Class                  = USB_CSCP_IADDeviceClass,

+	.SubClass               = USB_CSCP_IADDeviceSubclass,

+	.Protocol               = USB_CSCP_IADDeviceProtocol,

+

+	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,

+

+	.VendorID               = 0x03EB,

+	.ProductID              = 0x204E,

+	.ReleaseNumber          = VERSION_BCD(00.01),

+

+	.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.

+ */

+const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =

+{

+	.Config =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

+

+			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),

+			.TotalInterfaces        = 4,

+

+			.ConfigurationNumber    = 1,

+			.ConfigurationStrIndex  = NO_DESCRIPTOR,

+

+			.ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),

+

+			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)

+		},

+

+	.CDC1_IAD =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},

+

+			.FirstInterfaceIndex    = 0,

+			.TotalInterfaces        = 2,

+

+			.Class                  = CDC_CSCP_CDCClass,

+			.SubClass               = CDC_CSCP_ACMSubclass,

+			.Protocol               = CDC_CSCP_ATCommandProtocol,

+

+			.IADStrIndex            = NO_DESCRIPTOR

+		},

+

+	.CDC1_CCI_Interface =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

+

+			.InterfaceNumber        = 0,

+			.AlternateSetting       = 0,

+

+			.TotalEndpoints         = 1,

+

+			.Class                  = CDC_CSCP_CDCClass,

+			.SubClass               = CDC_CSCP_ACMSubclass,

+			.Protocol               = CDC_CSCP_ATCommandProtocol,

+

+			.InterfaceStrIndex      = NO_DESCRIPTOR

+		},

+

+	.CDC1_Functional_Header =

+		{

+			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},

+			.Subtype                = CDC_DSUBTYPE_CSInterface_Header,

+

+			.CDCSpecification       = VERSION_BCD(01.10),

+		},

+

+	.CDC1_Functional_ACM =

+		{

+			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},

+			.Subtype                = CDC_DSUBTYPE_CSInterface_ACM,

+

+			.Capabilities           = 0x06,

+		},

+

+	.CDC1_Functional_Union =

+		{

+			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},

+			.Subtype                = CDC_DSUBTYPE_CSInterface_Union,

+

+			.MasterInterfaceNumber  = 0,

+			.SlaveInterfaceNumber   = 1,

+		},

+

+	.CDC1_ManagementEndpoint =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

+

+			.EndpointAddress        = (ENDPOINT_DIR_IN | CDC1_NOTIFICATION_EPNUM),

+			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),

+			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,

+			.PollingIntervalMS      = 0xFF

+		},

+

+	.CDC1_DCI_Interface =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

+

+			.InterfaceNumber        = 1,

+			.AlternateSetting       = 0,

+

+			.TotalEndpoints         = 2,

+

+			.Class                  = CDC_CSCP_CDCDataClass,

+			.SubClass               = CDC_CSCP_NoDataSubclass,

+			.Protocol               = CDC_CSCP_NoDataProtocol,

+

+			.InterfaceStrIndex      = NO_DESCRIPTOR

+		},

+

+	.CDC1_DataOutEndpoint =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

+

+			.EndpointAddress        = (ENDPOINT_DIR_OUT | CDC1_RX_EPNUM),

+			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),

+			.EndpointSize           = CDC_TXRX_EPSIZE,

+			.PollingIntervalMS      = 0x01

+		},

+

+	.CDC1_DataInEndpoint =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

+

+			.EndpointAddress        = (ENDPOINT_DIR_IN | CDC1_TX_EPNUM),

+			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),

+			.EndpointSize           = CDC_TXRX_EPSIZE,

+			.PollingIntervalMS      = 0x01

+		},

+

+	.CDC2_IAD =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},

+

+			.FirstInterfaceIndex    = 2,

+			.TotalInterfaces        = 2,

+

+			.Class                  = CDC_CSCP_CDCClass,

+			.SubClass               = CDC_CSCP_ACMSubclass,

+			.Protocol               = CDC_CSCP_ATCommandProtocol,

+

+			.IADStrIndex            = NO_DESCRIPTOR

+		},

+

+	.CDC2_CCI_Interface =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

+

+			.InterfaceNumber        = 2,

+			.AlternateSetting       = 0,

+

+			.TotalEndpoints         = 1,

+

+			.Class                  = CDC_CSCP_CDCClass,

+			.SubClass               = CDC_CSCP_ACMSubclass,

+			.Protocol               = CDC_CSCP_ATCommandProtocol,

+

+			.InterfaceStrIndex      = NO_DESCRIPTOR

+		},

+

+	.CDC2_Functional_Header =

+		{

+			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},

+			.Subtype                = CDC_DSUBTYPE_CSInterface_Header,

+

+			.CDCSpecification       = VERSION_BCD(01.10),

+		},

+

+	.CDC2_Functional_ACM =

+		{

+			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},

+			.Subtype                = CDC_DSUBTYPE_CSInterface_ACM,

+

+			.Capabilities           = 0x06,

+		},

+

+	.CDC2_Functional_Union =

+		{

+			.Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},

+			.Subtype                = CDC_DSUBTYPE_CSInterface_Union,

+

+			.MasterInterfaceNumber  = 2,

+			.SlaveInterfaceNumber   = 3,

+		},

+

+	.CDC2_ManagementEndpoint =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

+

+			.EndpointAddress        = (ENDPOINT_DIR_IN | CDC2_NOTIFICATION_EPNUM),

+			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),

+			.EndpointSize           = CDC_NOTIFICATION_EPSIZE,

+			.PollingIntervalMS      = 0xFF

+		},

+

+	.CDC2_DCI_Interface =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

+

+			.InterfaceNumber        = 3,

+			.AlternateSetting       = 0,

+

+			.TotalEndpoints         = 2,

+

+			.Class                  = CDC_CSCP_CDCDataClass,

+			.SubClass               = CDC_CSCP_NoDataSubclass,

+			.Protocol               = CDC_CSCP_NoDataProtocol,

+

+			.InterfaceStrIndex      = NO_DESCRIPTOR

+		},

+

+	.CDC2_DataOutEndpoint =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

+

+			.EndpointAddress        = (ENDPOINT_DIR_OUT | CDC2_RX_EPNUM),

+			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),

+			.EndpointSize           = CDC_TXRX_EPSIZE,

+			.PollingIntervalMS      = 0x01

+		},

+

+	.CDC2_DataInEndpoint =

+		{

+			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

+

+			.EndpointAddress        = (ENDPOINT_DIR_IN | CDC2_TX_EPNUM),

+			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),

+			.EndpointSize           = CDC_TXRX_EPSIZE,

+			.PollingIntervalMS      = 0x01

+		}

+};

+

+/** 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.

+ */

+const USB_Descriptor_String_t PROGMEM 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.

+ */

+const USB_Descriptor_String_t PROGMEM ManufacturerString =

+{

+	.Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},

+#ifndef USB_MANUFACTURER

+  .UnicodeString          = L"Dean Camera"

+#else

+  .UnicodeString          = USB_MANUFACTURER

+#endif

+};

+

+/** 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.

+ */

+const USB_Descriptor_String_t PROGMEM ProductString =

+{

+	.Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},

+#ifndef USB_PRODUCT

+  .UnicodeString          = L"LUFA USB-RS232 Adapter"

+#else

+  .UnicodeString          = USB_PRODUCT

+#endif

+};

+

+/** 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.

+ */

+uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,

+                                    const uint8_t wIndex,

+                                    const void** const DescriptorAddress)

+{

+	const uint8_t  DescriptorType   = (wValue >> 8);

+	const uint8_t  DescriptorNumber = (wValue & 0xFF);

+

+	const void* Address = NULL;

+	uint16_t    Size    = NO_DESCRIPTOR;

+

+	switch (DescriptorType)

+	{

+		case DTYPE_Device:

+			Address = &DeviceDescriptor;

+			Size    = sizeof(USB_Descriptor_Device_t);

+			break;

+		case DTYPE_Configuration:

+			Address = &ConfigurationDescriptor;

+			Size    = sizeof(USB_Descriptor_Configuration_t);

+			break;

+		case DTYPE_String:

+			switch (DescriptorNumber)

+			{

+				case 0x00:

+					Address = &LanguageString;

+					Size    = pgm_read_byte(&LanguageString.Header.Size);

+					break;

+				case 0x01:

+					Address = &ManufacturerString;

+					Size    = pgm_read_byte(&ManufacturerString.Header.Size);

+					break;

+				case 0x02:

+					Address = &ProductString;

+					Size    = pgm_read_byte(&ProductString.Header.Size);

+					break;

+			}

+

+			break;

+	}

+

+	*DescriptorAddress = Address;

+	return Size;

+}

+

diff --git a/lib/lufa-descriptor-usbdualserial.h b/lib/lufa-descriptor-usbdualserial.h
new file mode 100644
index 0000000..d1e6ca6
--- /dev/null
+++ b/lib/lufa-descriptor-usbdualserial.h
@@ -0,0 +1,112 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2012.

+

+  dean [at] fourwalledcubicle [dot] com

+           www.lufa-lib.org

+*/

+

+/*

+  Copyright 2012  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

+ *

+ *  Header file for Descriptors.c.

+ */

+

+#ifndef _DESCRIPTORS_H_

+#define _DESCRIPTORS_H_

+

+	/* Includes: */

+		#include <avr/pgmspace.h>

+

+		#include <LUFA/Drivers/USB/USB.h>

+

+	/* Macros: */

+		/** Endpoint number of the first CDC interface's device-to-host data IN endpoint. */

+		#define CDC1_TX_EPNUM                  1

+

+		/** Endpoint number of the first CDC interface's host-to-device data OUT endpoint. */

+		#define CDC1_RX_EPNUM                  2

+

+		/** Endpoint number of the first CDC interface's device-to-host notification IN endpoint. */

+		#define CDC1_NOTIFICATION_EPNUM        3

+

+		/** Endpoint number of the second CDC interface's device-to-host data IN endpoint. */

+		#define CDC2_TX_EPNUM                  4

+

+		/** Endpoint number of the second CDC interface's host-to-device data OUT endpoint. */

+		#define CDC2_RX_EPNUM                  5

+

+		/** Endpoint number of the second CDC interface's device-to-host notification IN endpoint. */

+		#define CDC2_NOTIFICATION_EPNUM        6

+

+		/** Size in bytes of the CDC device-to-host notification IN endpoints. */

+		#define CDC_NOTIFICATION_EPSIZE        8

+

+		/** Size in bytes of the CDC data IN and OUT endpoints. */

+		#define CDC_TXRX_EPSIZE                16

+

+	/* Type Defines: */

+		/** Type define for the device configuration descriptor structure. This must be defined in the

+		 *  application code, as the configuration descriptor contains several sub-descriptors which

+		 *  vary between devices, and which describe the device's usage to the host.

+		 */

+		typedef struct

+		{

+			USB_Descriptor_Configuration_Header_t    Config;

+

+			// First CDC Control Interface

+			USB_Descriptor_Interface_Association_t   CDC1_IAD;

+			USB_Descriptor_Interface_t               CDC1_CCI_Interface;

+			USB_CDC_Descriptor_FunctionalHeader_t    CDC1_Functional_Header;

+			USB_CDC_Descriptor_FunctionalACM_t       CDC1_Functional_ACM;

+			USB_CDC_Descriptor_FunctionalUnion_t     CDC1_Functional_Union;

+			USB_Descriptor_Endpoint_t                CDC1_ManagementEndpoint;

+

+			// First CDC Data Interface

+			USB_Descriptor_Interface_t               CDC1_DCI_Interface;

+			USB_Descriptor_Endpoint_t                CDC1_DataOutEndpoint;

+			USB_Descriptor_Endpoint_t                CDC1_DataInEndpoint;

+

+			// Second CDC Control Interface

+			USB_Descriptor_Interface_Association_t   CDC2_IAD;

+			USB_Descriptor_Interface_t               CDC2_CCI_Interface;

+			USB_CDC_Descriptor_FunctionalHeader_t    CDC2_Functional_Header;

+			USB_CDC_Descriptor_FunctionalACM_t       CDC2_Functional_ACM;

+			USB_CDC_Descriptor_FunctionalUnion_t     CDC2_Functional_Union;

+			USB_Descriptor_Endpoint_t                CDC2_ManagementEndpoint;

+

+			// Second CDC Data Interface

+			USB_Descriptor_Interface_t               CDC2_DCI_Interface;

+			USB_Descriptor_Endpoint_t                CDC2_DataOutEndpoint;

+			USB_Descriptor_Endpoint_t                CDC2_DataInEndpoint;

+		} USB_Descriptor_Configuration_t;

+

+	/* Function Prototypes: */

+		uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,

+		                                    const uint8_t wIndex,

+		                                    const void** const DescriptorAddress)

+		                                    ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);

+

+#endif

+