Demos/Device/LowLevel/DualCDC/DualCDC.c

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