Rename CDC demos to VirtualSerial.
[pub/lufa.git] / Demos / Device / LowLevel / DualVirtualSerial / DualCDC.h
diff --git a/Demos/Device/LowLevel/DualVirtualSerial/DualCDC.h b/Demos/Device/LowLevel/DualVirtualSerial/DualCDC.h
new file mode 100644 (file)
index 0000000..b2085c4
--- /dev/null
@@ -0,0 +1,119 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Header file for DualCDC.c.\r
+ */\r
+\r
+#ifndef _DUAL_CDC_H_\r
+#define _DUAL_CDC_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <avr/wdt.h>\r
+               #include <avr/power.h>\r
+               #include <string.h>\r
+\r
+               #include "Descriptors.h"\r
+\r
+               #include <LUFA/Version.h>\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+               #include <LUFA/Drivers/Board/Joystick.h>\r
+               #include <LUFA/Drivers/Board/LEDs.h>\r
+\r
+       /* Macros: */\r
+               /** CDC Class specific request to get the current virtual serial port configuration settings. */\r
+               #define REQ_GetLineEncoding          0x21\r
+\r
+               /** CDC Class specific request to set the current virtual serial port configuration settings. */\r
+               #define REQ_SetLineEncoding          0x20\r
+\r
+               /** CDC Class specific request to set the current virtual serial port handshake line states. */\r
+               #define REQ_SetControlLineState      0x22\r
+\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */\r
+               #define LEDMASK_USB_NOTREADY      LEDS_LED1\r
+\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */\r
+               #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)\r
+\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is ready. */\r
+               #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)\r
+\r
+               /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */\r
+               #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)\r
+\r
+       /* Type Defines: */\r
+               /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration\r
+                *  as set by the host via a class specific request.\r
+                */\r
+               typedef struct\r
+               {\r
+                       uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */\r
+                       uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the\r
+                                             *   CDCDevice_CDC_LineCodingFormats_t enum\r
+                                             */\r
+                       uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the\r
+                                             *   CDCDevice_LineCodingParity_t enum\r
+                                             */\r
+                       uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */\r
+               } CDC_Line_Coding_t;\r
+               \r
+       /* Enums: */\r
+               /** Enum for the possible line encoding formats of a virtual serial port. */\r
+               enum CDCDevice_CDC_LineCodingFormats_t\r
+               {\r
+                       OneStopBit          = 0, /**< Each frame contains one stop bit */\r
+                       OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */\r
+                       TwoStopBits         = 2, /**< Each frame contains two stop bits */\r
+               };\r
+               \r
+               /** Enum for the possible line encoding parity settings of a virtual serial port. */\r
+               enum CDCDevice_LineCodingParity_t\r
+               {\r
+                       Parity_None         = 0, /**< No parity bit mode on each frame */\r
+                       Parity_Odd          = 1, /**< Odd parity bit mode on each frame */\r
+                       Parity_Even         = 2, /**< Even parity bit mode on each frame */\r
+                       Parity_Mark         = 3, /**< Mark parity bit mode on each frame */\r
+                       Parity_Space        = 4, /**< Space parity bit mode on each frame */\r
+               };\r
+\r
+       /* Function Prototypes: */\r
+               void CDC1_Task(void);\r
+               void CDC2_Task(void);\r
+               void SetupHardware(void);\r
+\r
+               void EVENT_USB_Device_Connect(void);\r
+               void EVENT_USB_Device_Disconnect(void);\r
+               void EVENT_USB_Device_ConfigurationChanged(void);\r
+               void EVENT_USB_Device_UnhandledControlRequest(void);\r
+               \r
+#endif\r