Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.c

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