Change over instances of "make" in the makefiles to "$(MAKE)" to allow for the make...

[pub/USBasp.git] / 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 0c21444..0b2c4c0 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Device mode driver for the library USB CDC Class driver.\r
+ *\r
+ *  Device mode driver for the library USB CDC Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/CDC.h.\r
+ */\r
+\r

 /** \ingroup Group_USBClassCDC\r
  *  @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver\r
  *\r
 /** \ingroup Group_USBClassCDC\r
  *  @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver\r
  *\r


@@ -80,7 +89,9 @@
                \r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
                \r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r

-                       /** Class state structure. An instance of this structure should be made for each CDC interface\r
+                       /** \brief CDC Class Device Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made for each CDC interface\r

                         *  within the user application, and passed to each of the CDC class driver functions as the\r
                         *  CDCInterfaceInfo parameter. This stores each CDC interface's configuration and state information.\r
                         */\r
                         *  within the user application, and passed to each of the CDC class driver functions as the\r
                         *  CDCInterfaceInfo parameter. This stores each CDC interface's configuration and state information.\r
                         */\r


@@ -179,6 +190,14 @@
                         */\r
                        void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         */\r
                        void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
 \r

+                       /** CDC class driver event for a send break request sent to the device from the host. This is generally used to seperate\r
+                        *  data or to indicate a special condition to the receiving device.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *  \param[in]     Duration          Duration of the break that has been sent by the host, in milliseconds\r
+                        */\r
+                       void EVENT_CDC_Device_BreakSent(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);\r
+\r

                        /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the\r
                         *  string is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the\r
                         *  \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be \r
                        /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the\r
                         *  string is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the\r
                         *  \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be \r


@@ -296,6 +315,8 @@
                                                                                                                  ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r
                                void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)\r
                                                                                                                         ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r
                                                                                                                  ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r
                                void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)\r
                                                                                                                         ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r

+                               void EVENT_CDC_Device_BreakSent(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, uint8_t Duration)\r
+                                                               ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r

                        #endif\r
 \r
        #endif\r
                        #endif\r
 \r
        #endif\r