Minor documentation page updates.

[pub/USBasp.git] / Demos / Device / DualCDC / DualCDC.c

diff --git a/Demos/Device/DualCDC/DualCDC.c b/Demos/Device/DualCDC/DualCDC.c
index 26947f4..216902c 100644 (file)
--- a/Demos/Device/DualCDC/DualCDC.c
+++ b/Demos/Device/DualCDC/DualCDC.c
@@ -27,9 +27,20 @@
   arising out of or in connection with the use or performance of\r
   this software.\r
 */\r
- \r
+\r
+/** \file\r
+ *\r
+ *  Main source file for the DualCDC demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r
+ */\r
+\r
 #include "DualCDC.h"\r
 \r
+/** LUFA CDC Class driver interface configuration and state information. This structure is\r
+ *  passed to all CDC Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another. This is for the first CDC interface,\r
+ *  which sends strings to the host for each joystick movement.\r
+ */\r
 USB_ClassInfo_CDC_t VirtualSerial1_CDC_Interface =\r
        {\r
                .ControlInterfaceNumber     = 0,\r
@@ -44,9 +55,14 @@ USB_ClassInfo_CDC_t VirtualSerial1_CDC_Interface =
                .NotificationEndpointSize   = CDC_NOTIFICATION_EPSIZE,\r
        };\r
 \r
+/** LUFA CDC Class driver interface configuration and state information. This structure is\r
+ *  passed to all CDC Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another. This is for the second CDC interface,\r
+ *  which echos back all received data from the host.\r
+ */\r
 USB_ClassInfo_CDC_t VirtualSerial2_CDC_Interface =\r
        {\r
-               .ControlInterfaceNumber     = 0,\r
+               .ControlInterfaceNumber     = 2,\r
 \r
                .DataINEndpointNumber       = CDC2_TX_EPNUM,\r
                .DataINEndpointSize         = CDC_TXRX_EPSIZE,\r
@@ -58,6 +74,9 @@ USB_ClassInfo_CDC_t VirtualSerial2_CDC_Interface =
                .NotificationEndpointSize   = CDC_NOTIFICATION_EPSIZE,\r
        };\r
 \r
+/** Main program entry point. This routine contains the overall program flow, including initial\r
+ *  setup of all components and the main program loop.\r
+ */\r
 int main(void)\r
 {\r
        SetupHardware();\r
@@ -68,10 +87,12 @@ int main(void)
        {\r
                CheckJoystickMovement();\r
 \r
+               /* Discard all received data on the first CDC interface */\r
                uint16_t BytesToDiscard = USB_CDC_BytesReceived(&VirtualSerial1_CDC_Interface);\r
                while (BytesToDiscard--)\r
                  USB_CDC_ReceiveByte(&VirtualSerial1_CDC_Interface);\r
 \r
+               /* Echo all received data on the second CDC interface */\r
                uint16_t BytesToEcho = USB_CDC_BytesReceived(&VirtualSerial2_CDC_Interface);\r
                while (BytesToEcho--)\r
                  USB_CDC_SendByte(&VirtualSerial2_CDC_Interface, USB_CDC_ReceiveByte(&VirtualSerial2_CDC_Interface));\r
@@ -82,6 +103,7 @@ int main(void)
        }\r
 }\r
 \r
+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
 void SetupHardware(void)\r
 {\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
@@ -97,6 +119,9 @@ void SetupHardware(void)
        USB_Init();\r
 }\r
 \r
+/** Checks for changes in the position of the board joystick, sending strings to the host upon each change\r
+ *  through the first of the CDC interfaces.\r
+ */\r
 void CheckJoystickMovement(void)\r
 {\r
        uint8_t     JoyStatus_LCL = Joystick_GetStatus();\r
@@ -133,16 +158,19 @@ void CheckJoystickMovement(void)
        }\r
 }\r
 \r
+/** Event handler for the library USB Connection event. */\r
 void EVENT_USB_Connect(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
 }\r
 \r
+/** Event handler for the library USB Disconnection event. */\r
 void EVENT_USB_Disconnect(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
 }\r
 \r
+/** Event handler for the library USB Configuration Changed event. */\r
 void EVENT_USB_ConfigurationChanged(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
@@ -154,6 +182,7 @@ void EVENT_USB_ConfigurationChanged(void)
          LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r
 \r
+/** Event handler for the library USB Unhandled Control Packet event. */\r
 void EVENT_USB_UnhandledControlPacket(void)\r
 {\r
        USB_CDC_ProcessControlPacket(&VirtualSerial1_CDC_Interface);\r