X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/5a4def747897c1c6ffbe465506d846c7c686d3e9..d41cd9a41aca81eaa21e65e6c53672fe604fa3d5:/LUFA/Drivers/USB/Class/Common/CDC.h

diff --git a/LUFA/Drivers/USB/Class/Common/CDC.h b/LUFA/Drivers/USB/Class/Common/CDC.h
index 6d2c519b8..aaaf12144 100644
--- a/LUFA/Drivers/USB/Class/Common/CDC.h
+++ b/LUFA/Drivers/USB/Class/Common/CDC.h
@@ -3,7 +3,7 @@
      Copyright (C) Dean Camera, 2010.
 
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
@@ -33,8 +33,8 @@
  *
  *  Common definitions and declarations for the library USB CDC Class driver.
  *
- *  \note This file should not be included directly. It is automatically included as needed by the class driver
- *        dispatch header located in LUFA/Drivers/USB/Class/CDC.h.
+ *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ *        dispatch header located in LUFA/Drivers/USB.h.
  */
 
 /** \ingroup Group_USBClassCDC
@@ -51,7 +51,7 @@
 #define _CDC_CLASS_COMMON_H_
 
 	/* Includes: */
-		#include "../../USB.h"
+		#include "../../HighLevel/StdDescriptors.h"
 
 		#include <string.h>
 
@@ -62,10 +62,12 @@
 
 	/* Preprocessor Checks: */
 		#if !defined(__INCLUDE_FROM_CDC_DRIVER)
-			#error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.
+			#error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
 		#endif
 
 	/* Macros: */
+		/** \name Virtual Control Line Masks */
+		//@{
 		/** Mask for the DTR handshake line for use with the \ref CDC_REQ_SetControlLineState class-specific request
 		 *  from the host, to indicate that the DTR line state should be high.
 		 */
@@ -110,7 +112,8 @@
 		 *  to indicate that a data overrun error has occurred on the virtual serial port.
 		 */
 		#define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6)
-
+		//@}
+		
 		/** Macro to define a CDC class-specific functional descriptor. CDC functional descriptors have a
 		 *  uniform structure but variable sized data payloads, thus cannot be represented accurately by
 		 *  a single typedef struct. A macro is used instead so that functional descriptors can be created
@@ -127,6 +130,40 @@
 		     }
 
 	/* Enums: */
+		/** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the CDC
+		 *  device class.
+		 */
+		enum CDC_Descriptor_ClassSubclassProtocol_t
+		{
+			CDC_CSCP_CDCClass               = 0x02, /**< Descriptor Class value indicating that the device or interface
+			                                         *   belongs to the CDC class.
+			                                         */
+			CDC_CSCP_NoSpecificSubclass     = 0x00, /**< Descriptor Subclass value indicating that the device or interface
+			                                         *   belongs to no specific subclass of the CDC class.
+			                                         */
+			CDC_CSCP_ACMSubclass            = 0x02, /**< Descriptor Subclass value indicating that the device or interface
+			                                         *   belongs to the Abstract Control Model CDC subclass.
+			                                         */
+			CDC_CSCP_ATCommandProtocol      = 0x01, /**< Descriptor Protocol value indicating that the device or interface
+			                                         *   belongs to the AT Command protocol of the CDC class.
+			                                         */
+			CDC_CSCP_NoSpecificProtocol     = 0x00, /**< Descriptor Class value indicating that the device or interface
+			                                         *   belongs to no specific protocol of the CDC class.
+			                                         */
+			CDC_CSCP_VendorSpecificProtocol = 0xFF, /**< Descriptor Class value indicating that the device or interface
+			                                         *   belongs to a vendor-specific protocol of the CDC class.
+			                                         */
+			CDC_CSCP_CDCDataClass           = 0x0A, /**< Descriptor Class value indicating that the device or interface
+			                                         *   belongs to the CDC Data class.
+			                                         */
+			CDC_CSCP_NoDataSubclass         = 0x00, /**< Descriptor Subclass value indicating that the device or interface
+			                                         *   belongs to no specific subclass of the CDC data class.
+			                                         */
+			CDC_CSCP_NoDataProtocol         = 0x00, /**< Descriptor Protocol value indicating that the device or interface
+			                                         *   belongs to no specific protocol of the CDC data class.
+			                                         */
+		};
+		
 		/** Enum for the CDC class specific control requests that can be issued by the USB bus host. */
 		enum CDC_ClassRequests_t
 		{
@@ -308,6 +345,21 @@
 			uint8_t bMasterInterface; /**< Interface number of the CDC Control interface. */
 			uint8_t bSlaveInterface0; /**< Interface number of the CDC Data interface. */
 		} USB_CDC_StdDescriptor_FunctionalUnion_t;
+		
+		/** Type define for a CDC Line Encoding structure, used to hold the various encoding parameters for a virtual
+		 *  serial port.
+		 */
+		typedef struct
+		{
+			uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second. */
+			uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
+								  *   \ref CDC_LineEncodingFormats_t enum.
+								  */
+			uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
+								  *   \ref CDC_LineEncodingParity_t enum.
+								  */
+			uint8_t  DataBits; /**< Bits of data per character of the virtual serial port. */
+		} CDC_LineEncoding_t;
 
 	/* Disable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)