X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/a67bd74e3e8aad87dcee8cf0c0eaaccbe7d00552..f51017f8fb5a02029bce577e3d7226cb5158d830:/LUFA/Drivers/USB/Class/Device/CDC.h

diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h
index b1d7c6dda..ee9e3767d 100644
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -28,6 +28,20 @@
   this software.
 */
 
+/** \ingroup Group_USBDeviceClassDrivers
+ *  @defgroup Group_USBClassCDCDevice CDC Device Class Driver - LUFA/Drivers/Class/Device/CDC.h
+ *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/USB/Class/Device/CDC.c
+ *
+ *  \section Module Description
+ *  Functions, macros, variables, enums and types related to the management of USB CDC Class interfaces
+ *  within a USB device, for the implementation of CDC-ACM virtual serial ports.
+ *
+ *  @{
+ */
+ 
 #ifndef _CDC_CLASS_H_
 #define _CDC_CLASS_H_
 
@@ -153,7 +167,7 @@
 			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;
+			uint8_t  ControlLineState; /**< Current control line states, as set by the host */
 
 			struct
 			{
@@ -173,21 +187,58 @@
 			void USB_CDC_Event_Stub(void);
 			void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)
 												   ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub);
-			void EVENT_USB_CDC_ControLineStateChanged(void) ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub);; 
+			void EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)
+			                                          ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub);
 		#endif
 	
-		bool     USB_CDC_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
-		void     USB_CDC_ProcessControlPacket(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
-		void     USB_CDC_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
+		/** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library
+		 *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
+		 *  given CDC interface is selected.
+		 *
+		 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
+		 *
+		 *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
+		 */
+		bool USB_CDC_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
+
+		/** Processes incomming control requests from the host, that are directed to the given CDC class interface. This should be
+		 *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
+		 *
+		 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
+		 */
+		void USB_CDC_ProcessControlPacket(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
+
+		/** General management task for a given CDC class interface, required for the correct operation of the interface. This should
+		 *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
+		 *
+		 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
+		 */
+		void USB_CDC_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
 
-		void     EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
-		void     EVENT_USB_CDC_ControLineStateChanged(void);
+		/** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a
+		 *  line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the
+		 *  user program by declaring a handler function with the same name and parameters listed here. The new line encoding
+		 *  settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.
+		 *
+		 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
+		 */
+		void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
+		
+		/** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
+		 *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
+		 *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
+		 *  are available in the ControlLineState value inside the CDC interface structure passed as a parameter, set as a mask of
+		 *  CDC_CONTROL_LINE_OUT_* masks.
+		 *
+		 *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
+		 */		
+		void EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
 
 		void     USB_CDC_SendString(USB_ClassInfo_CDC_t* CDCInterfaceInfo, char* Data, uint16_t Length);
 		void     USB_CDC_SendByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint8_t Data);
 		uint16_t USB_CDC_BytesReceived(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
 		uint8_t  USB_CDC_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo);
-		void USB_CDC_SendSerialLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);
+		void     USB_CDC_SendSerialLineStateChange(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);
 
 	/* Disable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)
@@ -195,3 +246,5 @@
 		#endif
 		
 #endif
+
+/** @} */