Demos/Device/LowLevel/DualVirtualSerial/DualVirtualSerial.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the DualVirtualSerial demo. This file contains the main tasks of the demo and
  34  *  is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "DualVirtualSerial.h"
  38
  39 /** Contains the current baud rate and other settings of the first virtual serial port. While this demo does not use
  40  *  the physical USART and thus does not use these settings, they must still be retained and returned to the host
  41  *  upon request or the host will assume the device is non-functional.
  42  *
  43  *  These values are set by the host via a class-specific request, however they are not required to be used accurately.
  44  *  It is possible to completely ignore these value or use other settings as the host is completely unaware of the physical
  45  *  serial link characteristics and instead sends and receives data in endpoint streams.
  46  */
  47 CDC_Line_Coding_t LineEncoding1 = { .BaudRateBPS = 0,
  48                                     .CharFormat  = OneStopBit,
  49                                     .ParityType  = Parity_None,
  50                                     .DataBits    = 8            };
  51
  52 /** Contains the current baud rate and other settings of the second virtual serial port. While this demo does not use
  53  *  the physical USART and thus does not use these settings, they must still be retained and returned to the host
  54  *  upon request or the host will assume the device is non-functional.
  55  *
  56  *  These values are set by the host via a class-specific request, however they are not required to be used accurately.
  57  *  It is possible to completely ignore these value or use other settings as the host is completely unaware of the physical
  58  *  serial link characteristics and instead sends and receives data in endpoint streams.
  59  */
  60 CDC_Line_Coding_t LineEncoding2 = { .BaudRateBPS = 0,
  61                                     .CharFormat  = OneStopBit,
  62                                     .ParityType  = Parity_None,
  63                                     .DataBits    = 8            };
  64
  65
  66 /** Main program entry point. This routine configures the hardware required by the application, then
  67  *  enters a loop to run the application tasks in sequence.
  68  */
  69 int main(void)
  70 {
  71         SetupHardware();
  72
  73         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  74         sei();
  75
  76         for (;;)
  77         {
  78                 CDC1_Task();
  79                 CDC2_Task();
  80                 USB_USBTask();
  81         }
  82 }
  83
  84 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  85 void SetupHardware(void)
  86 {
  87         /* Disable watchdog if enabled by bootloader/fuses */
  88         MCUSR &= ~(1 << WDRF);
  89         wdt_disable();
  90
  91         /* Disable clock division */
  92         clock_prescale_set(clock_div_1);
  93
  94         /* Hardware Initialization */
  95         Joystick_Init();
  96         LEDs_Init();
  97         USB_Init();
  98 }
  99
 100 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
 101  *  starts the library USB task to begin the enumeration and USB management process.
 102  */
 103 void EVENT_USB_Device_Connect(void)
 104 {
 105         /* Indicate USB enumerating */
 106         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 107 }
 108
 109 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
 110  *  the status LEDs and stops the USB management and CDC management tasks.
 111  */
 112 void EVENT_USB_Device_Disconnect(void)
 113 {
 114         /* Indicate USB not ready */
 115         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 116 }
 117
 118 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration
 119  *  of the USB device after enumeration - the device endpoints are configured and the CDC management tasks are started.
 120  */
 121 void EVENT_USB_Device_ConfigurationChanged(void)
 122 {
 123         bool ConfigSuccess = true;
 124
 125         /* Setup first CDC Interface's Endpoints */
 126         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC1_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
 127                                                     CDC_NOTIFICATION_EPSIZE, ENDPOINT_BANK_SINGLE);
 128         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC1_TX_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_IN,
 129                                                     CDC_TXRX_EPSIZE, ENDPOINT_BANK_SINGLE);
 130         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC1_RX_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_OUT,
 131                                                     CDC_TXRX_EPSIZE, ENDPOINT_BANK_SINGLE);
 132
 133         /* Setup second CDC Interface's Endpoints */
 134         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC2_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
 135                                                     CDC_NOTIFICATION_EPSIZE, ENDPOINT_BANK_SINGLE);
 136         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC2_TX_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_IN,
 137                                                     CDC_TXRX_EPSIZE, ENDPOINT_BANK_SINGLE);
 138         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC2_RX_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_OUT,
 139                                                     CDC_TXRX_EPSIZE, ENDPOINT_BANK_SINGLE);
 140
 141         /* Reset line encoding baud rates so that the host knows to send new values */
 142         LineEncoding1.BaudRateBPS = 0;
 143         LineEncoding2.BaudRateBPS = 0;
 144
 145         /* Indicate endpoint configuration success or failure */
 146         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 147 }
 148
 149 /** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific
 150  *  control requests that are not handled internally by the USB library (including the CDC control commands,
 151  *  which are all issued via the control endpoint), so that they can be handled appropriately for the application.
 152  */
 153 void EVENT_USB_Device_UnhandledControlRequest(void)
 154 {
 155         /* Determine which interface's Line Coding data is being set from the wIndex parameter */
 156         uint8_t* LineEncodingData = (USB_ControlRequest.wIndex == 0) ? (uint8_t*)&LineEncoding1 : (uint8_t*)&LineEncoding2;
 157
 158         /* Process CDC specific control requests */
 159         switch (USB_ControlRequest.bRequest)
 160         {
 161                 case REQ_GetLineEncoding:
 162                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 163                         {
 164                                 /* Acknowledge the SETUP packet, ready for data transfer */
 165                                 Endpoint_ClearSETUP();
 166
 167                                 /* Write the line coding data to the control endpoint */
 168                                 Endpoint_Write_Control_Stream_LE(LineEncodingData, sizeof(CDC_Line_Coding_t));
 169
 170                                 /* Finalize the stream transfer to send the last packet or clear the host abort */
 171                                 Endpoint_ClearOUT();
 172                         }
 173
 174                         break;
 175                 case REQ_SetLineEncoding:
 176                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 177                         {
 178                                 /* Acknowledge the SETUP packet, ready for data transfer */
 179                                 Endpoint_ClearSETUP();
 180
 181                                 /* Read the line coding data in from the host into the global struct */
 182                                 Endpoint_Read_Control_Stream_LE(LineEncodingData, sizeof(CDC_Line_Coding_t));
 183
 184                                 /* Finalize the stream transfer to clear the last packet from the host */
 185                                 Endpoint_ClearIN();
 186                         }
 187
 188                         break;
 189                 case REQ_SetControlLineState:
 190                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 191                         {
 192                                 /* Acknowledge the SETUP packet, ready for data transfer */
 193                                 Endpoint_ClearSETUP();
 194
 195                                 Endpoint_ClearStatusStage();
 196                         }
 197
 198                         break;
 199         }
 200 }
 201
 202 /** Function to manage CDC data transmission and reception to and from the host for the first CDC interface, which sends joystick
 203  *  movements to the host as ASCII strings.
 204  */
 205 void CDC1_Task(void)
 206 {
 207         char*       ReportString    = NULL;
 208         uint8_t     JoyStatus_LCL   = Joystick_GetStatus();
 209         static bool ActionSent      = false;
 210
 211         /* Device must be connected and configured for the task to run */
 212         if (USB_DeviceState != DEVICE_STATE_Configured)
 213           return;
 214
 215         /* Determine if a joystick action has occurred */
 216         if (JoyStatus_LCL & JOY_UP)
 217           ReportString = "Joystick Up\r\n";
 218         else if (JoyStatus_LCL & JOY_DOWN)
 219           ReportString = "Joystick Down\r\n";
 220         else if (JoyStatus_LCL & JOY_LEFT)
 221           ReportString = "Joystick Left\r\n";
 222         else if (JoyStatus_LCL & JOY_RIGHT)
 223           ReportString = "Joystick Right\r\n";
 224         else if (JoyStatus_LCL & JOY_PRESS)
 225           ReportString = "Joystick Pressed\r\n";
 226         else
 227           ActionSent = false;
 228
 229         /* Flag management - Only allow one string to be sent per action */
 230         if ((ReportString != NULL) && (ActionSent == false) && LineEncoding1.BaudRateBPS)
 231         {
 232                 ActionSent = true;
 233
 234                 /* Select the Serial Tx Endpoint */
 235                 Endpoint_SelectEndpoint(CDC1_TX_EPNUM);
 236
 237                 /* Write the String to the Endpoint */
 238                 Endpoint_Write_Stream_LE(ReportString, strlen(ReportString));
 239
 240                 /* Finalize the stream transfer to send the last packet */
 241                 Endpoint_ClearIN();
 242
 243                 /* Wait until the endpoint is ready for another packet */
 244                 Endpoint_WaitUntilReady();
 245
 246                 /* Send an empty packet to ensure that the host does not buffer data sent to it */
 247                 Endpoint_ClearIN();
 248         }
 249
 250         /* Select the Serial Rx Endpoint */
 251         Endpoint_SelectEndpoint(CDC1_RX_EPNUM);
 252
 253         /* Throw away any received data from the host */
 254         if (Endpoint_IsOUTReceived())
 255           Endpoint_ClearOUT();
 256 }
 257
 258 /** Function to manage CDC data transmission and reception to and from the host for the second CDC interface, which echoes back
 259  *  all data sent to it from the host.
 260  */
 261 void CDC2_Task(void)
 262 {
 263         /* Device must be connected and configured for the task to run */
 264         if (USB_DeviceState != DEVICE_STATE_Configured)
 265           return;
 266
 267         /* Select the Serial Rx Endpoint */
 268         Endpoint_SelectEndpoint(CDC2_RX_EPNUM);
 269
 270         /* Check to see if any data has been received */
 271         if (Endpoint_IsOUTReceived())
 272         {
 273                 /* Create a temp buffer big enough to hold the incoming endpoint packet */
 274                 uint8_t  Buffer[Endpoint_BytesInEndpoint()];
 275
 276                 /* Remember how large the incoming packet is */
 277                 uint16_t DataLength = Endpoint_BytesInEndpoint();
 278
 279                 /* Read in the incoming packet into the buffer */
 280                 Endpoint_Read_Stream_LE(&Buffer, DataLength);
 281
 282                 /* Finalize the stream transfer to send the last packet */
 283                 Endpoint_ClearOUT();
 284
 285                 /* Select the Serial Tx Endpoint */
 286                 Endpoint_SelectEndpoint(CDC2_TX_EPNUM);
 287
 288                 /* Write the received data to the endpoint */
 289                 Endpoint_Write_Stream_LE(&Buffer, DataLength);
 290
 291                 /* Finalize the stream transfer to send the last packet */
 292                 Endpoint_ClearIN();
 293
 294                 /* Wait until the endpoint is ready for the next packet */
 295                 Endpoint_WaitUntilReady();
 296
 297                 /* Send an empty packet to prevent host buffering */
 298                 Endpoint_ClearIN();
 299         }
 300 }