Don't fail Doxygen on versions built without various features.

[pub/USBasp.git] / Demos / Device / ClassDriver / VirtualSerial / VirtualSerial.c

diff --git a/Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.c b/Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.c
index d76f8cf..d9429ba 100644 (file)
--- a/Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.c
+++ b/Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.c
@@ -1,24 +1,24 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2014.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


@@ -33,7 +33,7 @@
  *  Main source file for the VirtualSerial demo. This file contains the main tasks of
  *  the demo and is responsible for the initial application hardware configuration.
  */
  *  Main source file for the VirtualSerial demo. This file contains the main tasks of
  *  the demo and is responsible for the initial application hardware configuration.
  */

- 
+

 #include "VirtualSerial.h"
 
 /** LUFA CDC Class driver interface configuration and state information. This structure is
 #include "VirtualSerial.h"
 
 /** LUFA CDC Class driver interface configuration and state information. This structure is


@@ -44,47 +44,53 @@ USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =
        {
                .Config =
                        {
        {
                .Config =
                        {

-                               .ControlInterfaceNumber         = 0,
-
-                               .DataINEndpointNumber           = CDC_TX_EPNUM,
-                               .DataINEndpointSize             = CDC_TXRX_EPSIZE,
-                               .DataINEndpointDoubleBank       = false,
-
-                               .DataOUTEndpointNumber          = CDC_RX_EPNUM,
-                               .DataOUTEndpointSize            = CDC_TXRX_EPSIZE,
-                               .DataOUTEndpointDoubleBank      = false,
-
-                               .NotificationEndpointNumber     = CDC_NOTIFICATION_EPNUM,
-                               .NotificationEndpointSize       = CDC_NOTIFICATION_EPSIZE,
-                               .NotificationEndpointDoubleBank = false,
+                               .ControlInterfaceNumber   = INTERFACE_ID_CDC_CCI,
+                               .DataINEndpoint           =
+                                       {
+                                               .Address          = CDC_TX_EPADDR,
+                                               .Size             = CDC_TXRX_EPSIZE,
+                                               .Banks            = 1,
+                                       },
+                               .DataOUTEndpoint =
+                                       {
+                                               .Address          = CDC_RX_EPADDR,
+                                               .Size             = CDC_TXRX_EPSIZE,
+                                               .Banks            = 1,
+                                       },
+                               .NotificationEndpoint =
+                                       {
+                                               .Address          = CDC_NOTIFICATION_EPADDR,
+                                               .Size             = CDC_NOTIFICATION_EPSIZE,
+                                               .Banks            = 1,
+                                       },

                        },
        };
 
 /** Standard file stream for the CDC interface when set up, so that the virtual CDC COM port can be
                        },
        };
 
 /** Standard file stream for the CDC interface when set up, so that the virtual CDC COM port can be

- *  used like any regular character stream in the C APIs
+ *  used like any regular character stream in the C APIs.

  */
 static FILE USBSerialStream;
 
  */
 static FILE USBSerialStream;
 

+

 /** Main program entry point. This routine contains the overall program flow, including initial
  *  setup of all components and the main program loop.
  */
 int main(void)
 {
        SetupHardware();
 /** Main program entry point. This routine contains the overall program flow, including initial
  *  setup of all components and the main program loop.
  */
 int main(void)
 {
        SetupHardware();

-       
+

        /* Create a regular character stream for the interface so that it can be used with the stdio.h functions */
        CDC_Device_CreateStream(&VirtualSerial_CDC_Interface, &USBSerialStream);
 
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        /* Create a regular character stream for the interface so that it can be used with the stdio.h functions */
        CDC_Device_CreateStream(&VirtualSerial_CDC_Interface, &USBSerialStream);
 
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);

-       sei();
+       GlobalInterruptEnable();

 
        for (;;)
        {
                CheckJoystickMovement();
 
        for (;;)
        {
                CheckJoystickMovement();

-                
+

                /* Must throw away unused bytes from the host, or it will lock up while waiting for the device */
                /* Must throw away unused bytes from the host, or it will lock up while waiting for the device */

-               while (CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface))
-                 CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);
+               CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);

 
                CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
                USB_USBTask();
 
                CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
                USB_USBTask();


@@ -94,12 +100,24 @@ int main(void)
 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 void SetupHardware(void)
 {
 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 void SetupHardware(void)
 {

+#if (ARCH == ARCH_AVR8)

        /* Disable watchdog if enabled by bootloader/fuses */
        MCUSR &= ~(1 << WDRF);
        wdt_disable();
 
        /* Disable clock division */
        clock_prescale_set(clock_div_1);
        /* Disable watchdog if enabled by bootloader/fuses */
        MCUSR &= ~(1 << WDRF);
        wdt_disable();
 
        /* Disable clock division */
        clock_prescale_set(clock_div_1);

+#elif (ARCH == ARCH_XMEGA)
+       /* Start the PLL to multiply the 2MHz RC oscillator to 32MHz and switch the CPU core to run from it */
+       XMEGACLK_StartPLL(CLOCK_SRC_INT_RC2MHZ, 2000000, F_CPU);
+       XMEGACLK_SetCPUClockSource(CLOCK_SRC_PLL);
+
+       /* Start the 32MHz internal RC oscillator and start the DFLL to increase it to 48MHz using the USB SOF as a reference */
+       XMEGACLK_StartInternalOscillator(CLOCK_SRC_INT_RC32MHZ);
+       XMEGACLK_StartDFLL(CLOCK_SRC_INT_RC32MHZ, DFLL_REF_INT_USBSOF, F_USB);
+
+       PMIC.CTRL = PMIC_LOLVLEN_bm | PMIC_MEDLVLEN_bm | PMIC_HILVLEN_bm;
+#endif

 
        /* Hardware Initialization */
        Joystick_Init();
 
        /* Hardware Initialization */
        Joystick_Init();


@@ -113,7 +131,7 @@ void CheckJoystickMovement(void)
        uint8_t     JoyStatus_LCL = Joystick_GetStatus();
        char*       ReportString  = NULL;
        static bool ActionSent    = false;
        uint8_t     JoyStatus_LCL = Joystick_GetStatus();
        char*       ReportString  = NULL;
        static bool ActionSent    = false;

-       
+

        if (JoyStatus_LCL & JOY_UP)
          ReportString = "Joystick Up\r\n";
        else if (JoyStatus_LCL & JOY_DOWN)
        if (JoyStatus_LCL & JOY_UP)
          ReportString = "Joystick Up\r\n";
        else if (JoyStatus_LCL & JOY_DOWN)


@@ -126,7 +144,7 @@ void CheckJoystickMovement(void)
          ReportString = "Joystick Pressed\r\n";
        else
          ActionSent = false;
          ReportString = "Joystick Pressed\r\n";
        else
          ActionSent = false;

-         
+

        if ((ReportString != NULL) && (ActionSent == false))
        {
                ActionSent = true;
        if ((ReportString != NULL) && (ActionSent == false))
        {
                ActionSent = true;


@@ -135,7 +153,7 @@ void CheckJoystickMovement(void)
                fputs(ReportString, &USBSerialStream);
 
                /* Alternatively, without the stream: */
                fputs(ReportString, &USBSerialStream);
 
                /* Alternatively, without the stream: */

-               // CDC_Device_SendString(&VirtualSerial_CDC_Interface, ReportString, strlen(ReportString));
+               // CDC_Device_SendString(&VirtualSerial_CDC_Interface, ReportString);

        }
 }
 
        }
 }
 


@@ -154,14 +172,31 @@ void EVENT_USB_Device_Disconnect(void)
 /** Event handler for the library USB Configuration Changed event. */
 void EVENT_USB_Device_ConfigurationChanged(void)
 {
 /** Event handler for the library USB Configuration Changed event. */
 void EVENT_USB_Device_ConfigurationChanged(void)
 {

-       LEDs_SetAllLEDs(LEDMASK_USB_READY);
+       bool ConfigSuccess = true;

 
 

-       if (!(CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface)))
-         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+       ConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
+
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);

 }
 
 }
 

-/** Event handler for the library USB Unhandled Control Request event. */
-void EVENT_USB_Device_UnhandledControlRequest(void)
+/** Event handler for the library USB Control Request reception event. */
+void EVENT_USB_Device_ControlRequest(void)

 {
        CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 }
 {
        CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 }

+
+/** CDC class driver callback function the processing of changes to the virtual
+ *  control lines sent from the host..
+ *
+ *  \param[in] CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced
+ */
+void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t *const CDCInterfaceInfo)
+{
+       /* You can get changes to the virtual CDC lines in this callback; a common
+          use-case is to use the Data Terminal Ready (DTR) flag to enable and
+          disable CDC communications in your application when set to avoid the
+          application blocking while waiting for a host to become ready and read
+          in the pending data from the USB endpoints.
+       */
+       bool HostReady = (CDCInterfaceInfo->State.ControlLineStates.HostToDevice & CDC_CONTROL_LINE_OUT_DTR) != 0;
+}