X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/afe6ae14023c7040befe73e49d00077d3425c564..d11ed10c5314c44dc01c06954d1d73d4894cbff8:/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 12f8b8381..f6844979d 100644
--- a/LUFA/Drivers/USB/Class/Common/CDC.h
+++ b/LUFA/Drivers/USB/Class/Common/CDC.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2009.
+     Copyright (C) Dean Camera, 2010.
               
   dean [at] fourwalledcubicle [dot] com
       www.fourwalledcubicle.com
 */
 
 /*
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
-
-  Permission to use, copy, modify, and distribute this software
-  and its documentation for any purpose and without fee is hereby
-  granted, 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
+  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
@@ -29,6 +29,12 @@
 */
 
 /** \ingroup Group_USBClassCDC
+ *  @defgroup Group_USBClassCDCCommon  Common Class Definitions
+ *
+ *  \section Module Description
+ *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
+ *  CDC Class.
+ *
  *  @{
  */
  
@@ -111,7 +117,7 @@
 		 *  a single typedef struct. A macro is used instead so that functional descriptors can be created
 		 *  easily by specifying the size of the payload. This allows sizeof() to work correctly.
 		 *
-		 *  \param DataSize  Size in bytes of the CDC functional descriptor's data payload
+		 *  \param[in] DataSize  Size in bytes of the CDC functional descriptor's data payload
 		 */
 		#define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \
 		     struct                                        \
@@ -123,7 +129,7 @@
 
 	/* Enums: */
 		/** Enum for the possible line encoding formats of a virtual serial port. */
-		enum CDCDevice_CDC_LineCodingFormats_t
+		enum CDC_LineCodingFormats_t
 		{
 			CDC_LINEENCODING_OneStopBit          = 0, /**< Each frame contains one stop bit */
 			CDC_LINEENCODING_OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */
@@ -131,7 +137,7 @@
 		};
 		
 		/** Enum for the possible line encoding parity settings of a virtual serial port. */
-		enum CDCDevice_LineCodingParity_t
+		enum CDC_LineCodingParity_t
 		{
 			CDC_PARITY_None    = 0, /**< No parity bit mode on each frame */
 			CDC_PARITY_Odd     = 1, /**< Odd parity bit mode on each frame */
@@ -140,40 +146,6 @@
 			CDC_PARITY_Space   = 4, /**< Space parity bit mode on each frame */
 		};
 
-	/* Type Defines: */
-		/** Class state structure. An instance of this structure should be made for each CDC interface
-		 *  within the user application, and passed to each of the CDC class driver functions as the
-		 *  CDCInterfaceInfo parameter. The contents of this structure should be set to their correct
-		 *  values when used, or ommitted to force the library to use default values.
-		 */
-		typedef struct
-		{
-			uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */
-
-			uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */
-			uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */
-
-			uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */
-			uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */
-
-			uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */
-			uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
-
-			uint8_t  ControlLineState; /**< Current control line states, as set by the host */
-
-			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
-									  *   CDCDevice_CDC_LineCodingFormats_t enum
-									  */
-				uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
-									  *   CDCDevice_LineCodingParity_t enum
-									  */
-				uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
-			} LineEncoding;
-		} USB_ClassInfo_CDC_t;
-
 	/* Disable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)
 			}