Add CDC Host class driver EVENT_CDC_Host_ControLineStateChanged() event.
authorDean Camera <dean@fourwalledcubicle.com>
Tue, 11 Aug 2009 10:02:50 +0000 (10:02 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Tue, 11 Aug 2009 10:02:50 +0000 (10:02 +0000)
Minor documentation fixes.

Demos/Device/ClassDriver/RNDISEthernet/Lib/ProtocolDecoders.c
LUFA/Drivers/USB/Class/Device/CDC.h
LUFA/Drivers/USB/Class/Host/CDC.h
LUFA/ManPages/ChangeLog.txt

index d4e2ceb..c6cd52a 100644 (file)
@@ -51,7 +51,7 @@
 \r
 /** Decodes an Ethernet frame header and prints its contents to through the USART in a human readable format.\r
  *\r
 \r
 /** Decodes an Ethernet frame header and prints its contents to through the USART in a human readable format.\r
  *\r
- *  \param[in] InDataStart  Pointer to the start of an Ethernet frame header\r
+ *  \param[in] FrameINData  Pointer to the start of an Ethernet frame information structure\r
  */\r
 void DecodeEthernetFrameHeader(Ethernet_Frame_Info_t* FrameINData)\r
 {\r
  */\r
 void DecodeEthernetFrameHeader(Ethernet_Frame_Info_t* FrameINData)\r
 {\r
index 0f3c794..7513f9f 100644 (file)
                         *  a mask of CDC_CONTROL_LINE_OUT_* masks.\r
                         *\r
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
                         *  a mask of CDC_CONTROL_LINE_OUT_* masks.\r
                         *\r
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
-                        */             \r
+                        */\r
                        void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);\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
                        void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);\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
index 03c9704..5baafaf 100644 (file)
                         *  \return Next received byte from the device, or 0 if no data received\r
                         */\r
                        uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
                         *  \return Next received byte from the device, or 0 if no data received\r
                         */\r
                        uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
+                       \r
+                       /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies\r
+                        *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the\r
+                        *  user program by declaring a handler function with the same name and parameters listed here. The new control line states\r
+                        *  are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as\r
+                        *  a mask of CDC_CONTROL_LINE_IN_* masks.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.\r
+                        */\r
+                       void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
index a28c0d6..a6ed06c 100644 (file)
@@ -9,7 +9,8 @@
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX\r
   *\r
   *  <b>New:</b>\r
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX\r
   *\r
   *  <b>New:</b>\r
-  *\r
+  *  - Added new host class drivers and matching demos to the library for rapid application development\r
+  *  \r
   *  <b>Changed:</b>\r
   *\r
   *  <b>Fixed:</b>\r
   *  <b>Changed:</b>\r
   *\r
   *  <b>Fixed:</b>\r
@@ -22,7 +23,7 @@
   *  \section Sec_ChangeLog090810 Version 090810\r
   *\r
   *  <b>New:</b>\r
   *  \section Sec_ChangeLog090810 Version 090810\r
   *\r
   *  <b>New:</b>\r
-  *  - Added new class drivers and matching demos to the library for rapid application development\r
+  *  - Added new device class drivers and matching demos to the library for rapid application development\r
   *  - Added new PrinterHost demo (thanks to John Andrews)\r
   *  - Added USB Missle Launcher project, submitted by Dave Fletcher\r
   *  - Added new Benito Arduino Programmer project\r
   *  - Added new PrinterHost demo (thanks to John Andrews)\r
   *  - Added USB Missle Launcher project, submitted by Dave Fletcher\r
   *  - Added new Benito Arduino Programmer project\r