Minor documentation page updates.

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

diff --git a/Demos/Device/USBtoSerial/USBtoSerial.c b/Demos/Device/USBtoSerial/USBtoSerial.c
index 7c89278..85826c2 100644 (file)
--- a/Demos/Device/USBtoSerial/USBtoSerial.c
+++ b/Demos/Device/USBtoSerial/USBtoSerial.c
@@ -28,11 +28,24 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *\r
+ *  Main source file for the USBtoSerial demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r
+ */\r
+\r
 #include "USBtoSerial.h"\r
 \r
+/** Circular buffer to hold data from the host before it is sent to the device via the serial port. */\r
 RingBuff_t Rx_Buffer;\r
+\r
+/** Circular buffer to hold data from the serial port before it is sent to the host. */\r
 RingBuff_t Tx_Buffer;\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.\r
+ */\r
 USB_ClassInfo_CDC_t VirtualSerial_CDC_Interface =\r
        {\r
                .ControlInterfaceNumber     = 0,\r
@@ -47,6 +60,9 @@ USB_ClassInfo_CDC_t VirtualSerial_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
@@ -77,6 +93,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
@@ -92,16 +109,19 @@ void SetupHardware(void)
        USB_Init();\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
@@ -110,27 +130,35 @@ 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(&VirtualSerial_CDC_Interface);\r
 }\r
 \r
+/** ISR to manage the reception of data from the serial port, placing received bytes into a circular buffer\r
+ *  for later transmission to the host.\r
+ */\r
 ISR(USART1_RX_vect, ISR_BLOCK)\r
 {\r
        if (USB_IsConnected)\r
          Buffer_StoreElement(&Tx_Buffer, UDR1);\r
 }\r
 \r
+/** Event handler for the CDC Class driver Line Encoding Changed event.\r
+ *\r
+ *  \param CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced\r
+ */\r
 void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
 {\r
        uint8_t ConfigMask = 0;\r
 \r
-       if (CDCInterfaceInfo->LineEncoding.ParityType == Parity_Odd)\r
+       if (CDCInterfaceInfo->LineEncoding.ParityType == CDC_PARITY_Odd)\r
          ConfigMask = ((1 << UPM11) | (1 << UPM10));\r
-       else if (CDCInterfaceInfo->LineEncoding.ParityType == Parity_Even)\r
+       else if (CDCInterfaceInfo->LineEncoding.ParityType == CDC_PARITY_Even)\r
          ConfigMask = (1 << UPM11);\r
 \r
-       if (CDCInterfaceInfo->LineEncoding.CharFormat == TwoStopBits)\r
+       if (CDCInterfaceInfo->LineEncoding.CharFormat == CDC_LINEENCODING_TwoStopBits)\r
          ConfigMask |= (1 << USBS1);\r
 \r
        if (CDCInterfaceInfo->LineEncoding.DataBits == 6)\r