Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2018.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2018  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 disclaims 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 VirtualSerialHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "VirtualSerialHost.h"
  38
  39 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_FG_CYAN "CDC Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         GlobalInterruptEnable();
  50
  51         for (;;)
  52         {
  53                 CDCHost_Task();
  54
  55                 USB_USBTask();
  56         }
  57 }
  58
  59 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  60 void SetupHardware(void)
  61 {
  62 #if (ARCH == ARCH_AVR8)
  63         /* Disable watchdog if enabled by bootloader/fuses */
  64         MCUSR &= ~(1 << WDRF);
  65         wdt_disable();
  66
  67         /* Disable clock division */
  68         clock_prescale_set(clock_div_1);
  69 #endif
  70
  71         /* Hardware Initialization */
  72         Serial_Init(9600, false);
  73         LEDs_Init();
  74         USB_Init();
  75
  76         /* Create a stdio stream for the serial port for stdin and stdout */
  77         Serial_CreateStream(NULL);
  78 }
  79
  80 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  81  *  starts the library USB task to begin the enumeration and USB management process.
  82  */
  83 void EVENT_USB_Host_DeviceAttached(void)
  84 {
  85         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  86         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  87 }
  88
  89 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  90  *  stops the library USB task management process.
  91  */
  92 void EVENT_USB_Host_DeviceUnattached(void)
  93 {
  94         puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
  95         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  96 }
  97
  98 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  99  *  enumerated by the host and is now ready to be used by the application.
 100  */
 101 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 102 {
 103         puts_P(PSTR("Getting Config Data.\r\n"));
 104
 105         uint8_t ErrorCode;
 106
 107         /* Get and process the configuration descriptor data */
 108         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 109         {
 110                 if (ErrorCode == ControlError)
 111                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 112                 else
 113                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 114
 115                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 116
 117                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 118                 return;
 119         }
 120
 121         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 122         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 123         {
 124                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 125                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 126
 127                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 128                 return;
 129         }
 130
 131         CDC_LineEncoding_t LineEncoding = { .BaudRateBPS = 9600,
 132                                             .CharFormat  = CDC_LINEENCODING_OneStopBit,
 133                                             .ParityType  = CDC_PARITY_None,
 134                                             .DataBits    = 8                            };
 135
 136         USB_ControlRequest = (USB_Request_Header_t)
 137         {
 138                 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 139                 .bRequest      = CDC_REQ_SetLineEncoding,
 140                 .wValue        = 0,
 141                 .wIndex        = 0,
 142                 .wLength       = sizeof(LineEncoding),
 143         };
 144
 145         /* Set the Line Encoding of the CDC interface within the device, so that it is ready to accept data */
 146         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 147         if (USB_Host_SendControlRequest(&LineEncoding) != HOST_SENDCONTROL_Successful)
 148         {
 149                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Line Encoding).\r\n"
 150                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 151
 152                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 153                 return;
 154         }
 155
 156         puts_P(PSTR("CDC Device Enumerated.\r\n"));
 157         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 158 }
 159
 160 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 161 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 162 {
 163         USB_Disable();
 164
 165         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 166                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 167
 168         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 169         for(;;);
 170 }
 171
 172 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 173  *  enumerating an attached USB device.
 174  */
 175 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 176                                             const uint8_t SubErrorCode)
 177 {
 178         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 179                                  " -- Error Code %d\r\n"
 180                                  " -- Sub Error Code %d\r\n"
 181                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 182
 183         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 184 }
 185
 186 /** Task to read in data received from the attached CDC device and print it to the serial port.
 187  */
 188 void CDCHost_Task(void)
 189 {
 190         if (USB_HostState != HOST_STATE_Configured)
 191           return;
 192
 193         /* Select the data IN pipe */
 194         Pipe_SelectPipe(CDC_DATA_IN_PIPE);
 195         Pipe_Unfreeze();
 196
 197         /* Check to see if a packet has been received */
 198         if (Pipe_IsINReceived())
 199         {
 200                 /* Re-freeze IN pipe after the packet has been received */
 201                 Pipe_Freeze();
 202
 203                 /* Check if data is in the pipe */
 204                 if (Pipe_IsReadWriteAllowed())
 205                 {
 206                         /* Get the length of the pipe data, and create a new buffer to hold it */
 207                         uint16_t BufferLength = Pipe_BytesInPipe();
 208                         uint8_t  Buffer[BufferLength];
 209
 210                         /* Read in the pipe data to the temporary buffer */
 211                         Pipe_Read_Stream_LE(Buffer, BufferLength, NULL);
 212
 213                         /* Print out the buffer contents to the USART */
 214                         for (uint16_t BufferByte = 0; BufferByte < BufferLength; BufferByte++)
 215                           putchar(Buffer[BufferByte]);
 216                 }
 217
 218                 /* Clear the pipe after it is read, ready for the next packet */
 219                 Pipe_ClearIN();
 220         }
 221
 222         /* Re-freeze IN pipe after use */
 223         Pipe_Freeze();
 224
 225         /* Select and unfreeze the notification pipe */
 226         Pipe_SelectPipe(CDC_NOTIFICATION_PIPE);
 227         Pipe_Unfreeze();
 228
 229         /* Check if a packet has been received */
 230         if (Pipe_IsINReceived())
 231         {
 232                 /* Discard the unused event notification */
 233                 Pipe_ClearIN();
 234         }
 235
 236         /* Freeze notification IN pipe after use */
 237         Pipe_Freeze();
 238 }
 239