Demos/Device/LowLevel/VirtualSerial/VirtualSerial.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 VirtualSerial demo. This file contains the main tasks of the demo and
  34  *  is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "VirtualSerial.h"
  38
  39 /** Contains the current baud rate and other settings of the 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 LineEncoding = { .BaudRateBPS = 0,
  48                                    .CharFormat  = OneStopBit,
  49                                    .ParityType  = Parity_None,
  50                                    .DataBits    = 8            };
  51
  52 /** Main program entry point. This routine contains the overall program flow, including initial
  53  *  setup of all components and the main program loop.
  54  */
  55 int main(void)
  56 {
  57         SetupHardware();
  58
  59         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  60         sei();
  61
  62         for (;;)
  63         {
  64                 CDC_Task();
  65                 USB_USBTask();
  66         }
  67 }
  68
  69 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  70 void SetupHardware(void)
  71 {
  72         /* Disable watchdog if enabled by bootloader/fuses */
  73         MCUSR &= ~(1 << WDRF);
  74         wdt_disable();
  75
  76         /* Disable clock division */
  77         clock_prescale_set(clock_div_1);
  78
  79         /* Hardware Initialization */
  80         Joystick_Init();
  81         LEDs_Init();
  82         USB_Init();
  83 }
  84
  85 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
  86  *  starts the library USB task to begin the enumeration and USB management process.
  87  */
  88 void EVENT_USB_Device_Connect(void)
  89 {
  90         /* Indicate USB enumerating */
  91         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  92 }
  93
  94 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
  95  *  the status LEDs and stops the USB management and CDC management tasks.
  96  */
  97 void EVENT_USB_Device_Disconnect(void)
  98 {
  99         /* Indicate USB not ready */
 100         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 101 }
 102
 103 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration
 104  *  of the USB device after enumeration - the device endpoints are configured and the CDC management task started.
 105  */
 106 void EVENT_USB_Device_ConfigurationChanged(void)
 107 {
 108         bool ConfigSuccess = true;
 109
 110         /* Setup CDC Data Endpoints */
 111         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
 112                                                     CDC_NOTIFICATION_EPSIZE, ENDPOINT_BANK_SINGLE);
 113         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_IN,
 114                                                     CDC_TXRX_EPSIZE, ENDPOINT_BANK_SINGLE);
 115         ConfigSuccess &= Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_OUT,
 116                                                     CDC_TXRX_EPSIZE, ENDPOINT_BANK_SINGLE);
 117
 118         /* Reset line encoding baud rate so that the host knows to send new values */
 119         LineEncoding.BaudRateBPS = 0;
 120
 121         /* Indicate endpoint configuration success or failure */
 122         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 123 }
 124
 125 /** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific
 126  *  control requests that are not handled internally by the USB library (including the CDC control commands,
 127  *  which are all issued via the control endpoint), so that they can be handled appropriately for the application.
 128  */
 129 void EVENT_USB_Device_UnhandledControlRequest(void)
 130 {
 131         /* Process CDC specific control requests */
 132         switch (USB_ControlRequest.bRequest)
 133         {
 134                 case REQ_GetLineEncoding:
 135                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 136                         {
 137                                 Endpoint_ClearSETUP();
 138
 139                                 /* Write the line coding data to the control endpoint */
 140                                 Endpoint_Write_Control_Stream_LE(&LineEncoding, sizeof(CDC_Line_Coding_t));
 141                                 Endpoint_ClearOUT();
 142                         }
 143
 144                         break;
 145                 case REQ_SetLineEncoding:
 146                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 147                         {
 148                                 Endpoint_ClearSETUP();
 149
 150                                 /* Read the line coding data in from the host into the global struct */
 151                                 Endpoint_Read_Control_Stream_LE(&LineEncoding, sizeof(CDC_Line_Coding_t));
 152                                 Endpoint_ClearIN();
 153                         }
 154
 155                         break;
 156                 case REQ_SetControlLineState:
 157                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 158                         {
 159                                 Endpoint_ClearSETUP();
 160                                 Endpoint_ClearStatusStage();
 161
 162                                 /* NOTE: Here you can read in the line state mask from the host, to get the current state of the output handshake
 163                                          lines. The mask is read in from the wValue parameter in USB_ControlRequest, and can be masked against the
 164                                                  CONTROL_LINE_OUT_* masks to determine the RTS and DTR line states using the following code:
 165                                 */
 166                         }
 167
 168                         break;
 169         }
 170 }
 171
 172 /** Function to manage CDC data transmission and reception to and from the host. */
 173 void CDC_Task(void)
 174 {
 175         char*       ReportString    = NULL;
 176         uint8_t     JoyStatus_LCL   = Joystick_GetStatus();
 177         static bool ActionSent      = false;
 178
 179         /* Device must be connected and configured for the task to run */
 180         if (USB_DeviceState != DEVICE_STATE_Configured)
 181           return;
 182
 183 #if 0
 184         /* NOTE: Here you can use the notification endpoint to send back line state changes to the host, for the special RS-232
 185          *       handshake signal lines (and some error states), via the CONTROL_LINE_IN_* masks and the following code:
 186          */
 187         USB_Notification_Header_t Notification = (USB_Notification_Header_t)
 188                 {
 189                         .NotificationType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
 190                         .Notification     = NOTIF_SerialState,
 191                         .wValue           = 0,
 192                         .wIndex           = 0,
 193                         .wLength          = sizeof(uint16_t),
 194                 };
 195
 196         uint16_t LineStateMask;
 197
 198         // Set LineStateMask here to a mask of CONTROL_LINE_IN_* masks to set the input handshake line states to send to the host
 199
 200         Endpoint_SelectEndpoint(CDC_NOTIFICATION_EPNUM);
 201         Endpoint_Write_Stream_LE(&Notification, sizeof(Notification));
 202         Endpoint_Write_Stream_LE(&LineStateMask, sizeof(LineStateMask));
 203         Endpoint_ClearIN();
 204 #endif
 205
 206         /* Determine if a joystick action has occurred */
 207         if (JoyStatus_LCL & JOY_UP)
 208           ReportString = "Joystick Up\r\n";
 209         else if (JoyStatus_LCL & JOY_DOWN)
 210           ReportString = "Joystick Down\r\n";
 211         else if (JoyStatus_LCL & JOY_LEFT)
 212           ReportString = "Joystick Left\r\n";
 213         else if (JoyStatus_LCL & JOY_RIGHT)
 214           ReportString = "Joystick Right\r\n";
 215         else if (JoyStatus_LCL & JOY_PRESS)
 216           ReportString = "Joystick Pressed\r\n";
 217         else
 218           ActionSent = false;
 219
 220         /* Flag management - Only allow one string to be sent per action */
 221         if ((ReportString != NULL) && (ActionSent == false) && LineEncoding.BaudRateBPS)
 222         {
 223                 ActionSent = true;
 224
 225                 /* Select the Serial Tx Endpoint */
 226                 Endpoint_SelectEndpoint(CDC_TX_EPNUM);
 227
 228                 /* Write the String to the Endpoint */
 229                 Endpoint_Write_Stream_LE(ReportString, strlen(ReportString));
 230
 231                 /* Remember if the packet to send completely fills the endpoint */
 232                 bool IsFull = (Endpoint_BytesInEndpoint() == CDC_TXRX_EPSIZE);
 233
 234                 /* Finalize the stream transfer to send the last packet */
 235                 Endpoint_ClearIN();
 236
 237                 /* If the last packet filled the endpoint, send an empty packet to release the buffer on
 238                  * the receiver (otherwise all data will be cached until a non-full packet is received) */
 239                 if (IsFull)
 240                 {
 241                         /* Wait until the endpoint is ready for another packet */
 242                         Endpoint_WaitUntilReady();
 243
 244                         /* Send an empty packet to ensure that the host does not buffer data sent to it */
 245                         Endpoint_ClearIN();
 246                 }
 247         }
 248
 249         /* Select the Serial Rx Endpoint */
 250         Endpoint_SelectEndpoint(CDC_RX_EPNUM);
 251
 252         /* Throw away any received data from the host */
 253         if (Endpoint_IsOUTReceived())
 254           Endpoint_ClearOUT();
 255 }
 256