Rename CDC demos to VirtualSerial.
[pub/lufa.git] / Demos / Device / LowLevel / VirtualSerial / CDC.c
diff --git a/Demos/Device/LowLevel/VirtualSerial/CDC.c b/Demos/Device/LowLevel/VirtualSerial/CDC.c
new file mode 100644 (file)
index 0000000..444dc01
--- /dev/null
@@ -0,0 +1,327 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Main source file for the CDC demo. This file contains the main tasks of the demo and\r
+ *  is responsible for the initial application hardware configuration.\r
+ */\r
+\r
+#include "CDC.h"\r
+\r
+/** Contains the current baud rate and other settings of the virtual serial port. While this demo does not use\r
+ *  the physical USART and thus does not use these settings, they must still be retained and returned to the host\r
+ *  upon request or the host will assume the device is non-functional.\r
+ *\r
+ *  These values are set by the host via a class-specific request, however they are not required to be used accurately.\r
+ *  It is possible to completely ignore these value or use other settings as the host is completely unaware of the physical\r
+ *  serial link characteristics and instead sends and receives data in endpoint streams.\r
+ */\r
+CDC_Line_Coding_t LineEncoding = { .BaudRateBPS = 0,\r
+                                   .CharFormat  = OneStopBit,\r
+                                   .ParityType  = Parity_None,\r
+                                   .DataBits    = 8            };\r
+\r
+\r
+#if 0\r
+/* NOTE: Here you can set up a standard stream using the created virtual serial port, so that the standard stream functions in\r
+ *       <stdio.h> can be used on the virtual serial port (e.g. fprintf(&USBSerial, "Test"); to print a string).\r
+ */\r
+       \r
+static int CDC_putchar(char c, FILE *stream)\r
+{        \r
+       Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
+\r
+       if (!(LineEncoding.BaudRateBPS))\r
+         return -1;\r
+       \r
+       if (Endpoint_WaitUntilReady())\r
+         return -1;\r
+\r
+       Endpoint_Write_Byte(c);\r
+       Endpoint_ClearIN();\r
+       \r
+       return 0;\r
+}\r
+\r
+static int CDC_getchar(FILE *stream)\r
+{\r
+       int c;\r
+\r
+       if (!(LineEncoding.BaudRateBPS))\r
+         return -1;\r
+\r
+       Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
+       \r
+       for (;;)\r
+       {\r
+               if (Endpoint_WaitUntilReady())\r
+                 return -1;\r
+       \r
+               if (!(Endpoint_BytesInEndpoint()))\r
+               {\r
+                       Endpoint_ClearOUT();\r
+               }\r
+               else\r
+               {\r
+                       c = Endpoint_Read_Byte();\r
+                       break;\r
+               }\r
+       }\r
+       \r
+       return c;\r
+}\r
+\r
+static FILE USBSerial = FDEV_SETUP_STREAM(CDC_putchar, CDC_getchar, _FDEV_SETUP_RW);\r
+#endif\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
+       \r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+       for (;;)\r
+       {\r
+               CDC_Task();\r
+               USB_USBTask();\r
+       }\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
+       MCUSR &= ~(1 << WDRF);\r
+       wdt_disable();\r
+\r
+       /* Disable clock division */\r
+       clock_prescale_set(clock_div_1);\r
+\r
+       /* Hardware Initialization */\r
+       Joystick_Init();\r
+       LEDs_Init();\r
+       USB_Init();\r
+}\r
+\r
+/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and\r
+ *  starts the library USB task to begin the enumeration and USB management process.\r
+ */\r
+void EVENT_USB_Device_Connect(void)\r
+{\r
+       /* Indicate USB enumerating */\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+}\r
+\r
+/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
+ *  the status LEDs and stops the USB management and CDC management tasks.\r
+ */\r
+void EVENT_USB_Device_Disconnect(void)\r
+{\r
+       /* Indicate USB not ready */\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+}\r
+\r
+/** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration\r
+ *  of the USB device after enumeration - the device endpoints are configured and the CDC management task started.\r
+ */\r
+void EVENT_USB_Device_ConfigurationChanged(void)\r
+{\r
+       /* Indicate USB connected and ready */\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+\r
+       /* Setup CDC Notification, Rx and Tx Endpoints */\r
+       if (!(Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r
+                                            ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,\r
+                                        ENDPOINT_BANK_SINGLE)))\r
+       {\r
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+       }\r
+       \r
+       if (!(Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK,\r
+                                            ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,\r
+                                        ENDPOINT_BANK_SINGLE)))\r
+       {\r
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+       }\r
+       \r
+       if (!(Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK,\r
+                                            ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,\r
+                                        ENDPOINT_BANK_SINGLE)))\r
+       {\r
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+       }\r
+       \r
+       /* Reset line encoding baud rate so that the host knows to send new values */\r
+       LineEncoding.BaudRateBPS = 0;\r
+}\r
+\r
+/** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific\r
+ *  control requests that are not handled internally by the USB library (including the CDC control commands,\r
+ *  which are all issued via the control endpoint), so that they can be handled appropriately for the application.\r
+ */\r
+void EVENT_USB_Device_UnhandledControlRequest(void)\r
+{\r
+       /* Process CDC specific control requests */\r
+       switch (USB_ControlRequest.bRequest)\r
+       {\r
+               case REQ_GetLineEncoding:\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {       \r
+                               /* Acknowledge the SETUP packet, ready for data transfer */\r
+                               Endpoint_ClearSETUP();\r
+\r
+                               /* Write the line coding data to the control endpoint */\r
+                               Endpoint_Write_Control_Stream_LE(&LineEncoding, sizeof(CDC_Line_Coding_t));\r
+                               \r
+                               /* Finalize the stream transfer to send the last packet or clear the host abort */\r
+                               Endpoint_ClearOUT();\r
+                       }\r
+                       \r
+                       break;\r
+               case REQ_SetLineEncoding:\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {\r
+                               /* Acknowledge the SETUP packet, ready for data transfer */\r
+                               Endpoint_ClearSETUP();\r
+\r
+                               /* Read the line coding data in from the host into the global struct */\r
+                               Endpoint_Read_Control_Stream_LE(&LineEncoding, sizeof(CDC_Line_Coding_t));\r
+\r
+                               /* Finalize the stream transfer to clear the last packet from the host */\r
+                               Endpoint_ClearIN();\r
+                       }\r
+       \r
+                       break;\r
+               case REQ_SetControlLineState:\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {\r
+                               /* Acknowledge the SETUP packet, ready for data transfer */\r
+                               Endpoint_ClearSETUP();\r
+                               \r
+                               /* NOTE: Here you can read in the line state mask from the host, to get the current state of the output handshake\r
+                                        lines. The mask is read in from the wValue parameter in USB_ControlRequest, and can be masked against the\r
+                                                CONTROL_LINE_OUT_* masks to determine the RTS and DTR line states using the following code:\r
+                               */\r
+                               \r
+                               Endpoint_ClearStatusStage();\r
+                       }\r
+       \r
+                       break;\r
+       }\r
+}\r
+\r
+/** Function to manage CDC data transmission and reception to and from the host. */\r
+void CDC_Task(void)\r
+{\r
+       char*       ReportString    = NULL;\r
+       uint8_t     JoyStatus_LCL   = Joystick_GetStatus();\r
+       static bool ActionSent      = false;\r
+       \r
+       /* Device must be connected and configured for the task to run */\r
+       if (USB_DeviceState != DEVICE_STATE_Configured)\r
+         return;\r
+         \r
+#if 0\r
+       /* NOTE: Here you can use the notification endpoint to send back line state changes to the host, for the special RS-232\r
+        *       handshake signal lines (and some error states), via the CONTROL_LINE_IN_* masks and the following code:\r
+        */\r
+       USB_Notification_Header_t Notification = (USB_Notification_Header_t)\r
+               {\r
+                       .NotificationType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r
+                       .Notification     = NOTIF_SerialState,\r
+                       .wValue           = 0,\r
+                       .wIndex           = 0,\r
+                       .wLength          = sizeof(uint16_t),\r
+               };\r
+               \r
+       uint16_t LineStateMask;\r
+       \r
+       // Set LineStateMask here to a mask of CONTROL_LINE_IN_* masks to set the input handshake line states to send to the host\r
+       \r
+       Endpoint_SelectEndpoint(CDC_NOTIFICATION_EPNUM);\r
+       Endpoint_Write_Stream_LE(&Notification, sizeof(Notification));\r
+       Endpoint_Write_Stream_LE(&LineStateMask, sizeof(LineStateMask));\r
+       Endpoint_ClearIN();\r
+#endif\r
+\r
+       /* Determine if a joystick action has occurred */\r
+       if (JoyStatus_LCL & JOY_UP)\r
+         ReportString = "Joystick Up\r\n";\r
+       else if (JoyStatus_LCL & JOY_DOWN)\r
+         ReportString = "Joystick Down\r\n";\r
+       else if (JoyStatus_LCL & JOY_LEFT)\r
+         ReportString = "Joystick Left\r\n";\r
+       else if (JoyStatus_LCL & JOY_RIGHT)\r
+         ReportString = "Joystick Right\r\n";\r
+       else if (JoyStatus_LCL & JOY_PRESS)\r
+         ReportString = "Joystick Pressed\r\n";\r
+       else\r
+         ActionSent = false;\r
+\r
+       /* Flag management - Only allow one string to be sent per action */\r
+       if ((ReportString != NULL) && (ActionSent == false) && LineEncoding.BaudRateBPS)\r
+       {\r
+               ActionSent = true;\r
+\r
+               /* Select the Serial Tx Endpoint */\r
+               Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
+\r
+               /* Write the String to the Endpoint */\r
+               Endpoint_Write_Stream_LE(ReportString, strlen(ReportString));\r
+               \r
+               /* Remember if the packet to send completely fills the endpoint */\r
+               bool IsFull = (Endpoint_BytesInEndpoint() == CDC_TXRX_EPSIZE);\r
+\r
+               /* Finalize the stream transfer to send the last packet */\r
+               Endpoint_ClearIN();\r
+\r
+               /* If the last packet filled the endpoint, send an empty packet to release the buffer on \r
+                * the receiver (otherwise all data will be cached until a non-full packet is received) */\r
+               if (IsFull)\r
+               {\r
+                       /* Wait until the endpoint is ready for another packet */\r
+                       Endpoint_WaitUntilReady();\r
+                       \r
+                       /* Send an empty packet to ensure that the host does not buffer data sent to it */\r
+                       Endpoint_ClearIN();\r
+               }\r
+       }\r
+\r
+       /* Select the Serial Rx Endpoint */\r
+       Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
+       \r
+       /* Throw away any received data from the host */\r
+       if (Endpoint_IsOUTReceived())\r
+         Endpoint_ClearOUT();\r
+}\r