Demos/Host/ClassDriver/VirtualSerialHost/VirtualSerialHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 /** LUFA CDC Class driver interface configuration and state information. This structure is
  40  *  passed to all CDC Class driver functions, so that multiple instances of the same class
  41  *  within a device can be differentiated from one another.
  42  */
  43 USB_ClassInfo_CDC_Host_t VirtualSerial_CDC_Interface =
  44         {
  45                 .Config =
  46                         {
  47                                 .DataINPipe             =
  48                                         {
  49                                                 .Address        = (PIPE_DIR_IN  | 1),
  50                                                 .Banks          = 1,
  51                                         },
  52                                 .DataOUTPipe            =
  53                                         {
  54                                                 .Address        = (PIPE_DIR_OUT | 2),
  55                                                 .Banks          = 1,
  56                                         },
  57                                 .NotificationPipe       =
  58                                         {
  59                                                 .Address        = (PIPE_DIR_IN  | 3),
  60                                                 .Banks          = 1,
  61                                         },
  62                         },
  63         };
  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         puts_P(PSTR(ESC_FG_CYAN "CDC Host Demo running.\r\n" ESC_FG_WHITE));
  74
  75         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  76         GlobalInterruptEnable();
  77
  78         for (;;)
  79         {
  80                 CDCHost_Task();
  81
  82                 CDC_Host_USBTask(&VirtualSerial_CDC_Interface);
  83                 USB_USBTask();
  84         }
  85 }
  86
  87 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  88 void SetupHardware(void)
  89 {
  90 #if (ARCH == ARCH_AVR8)
  91         /* Disable watchdog if enabled by bootloader/fuses */
  92         MCUSR &= ~(1 << WDRF);
  93         wdt_disable();
  94
  95         /* Disable clock division */
  96         clock_prescale_set(clock_div_1);
  97 #endif
  98
  99         /* Hardware Initialization */
 100         Serial_Init(9600, false);
 101         LEDs_Init();
 102         USB_Init();
 103
 104         /* Create a stdio stream for the serial port for stdin and stdout */
 105         Serial_CreateStream(NULL);
 106 }
 107
 108 /** Task to manage an enumerated USB CDC device once connected, to print received data
 109  *  from the device to the serial port.
 110  */
 111 void CDCHost_Task(void)
 112 {
 113         if (USB_HostState != HOST_STATE_Configured)
 114           return;
 115
 116         if (CDC_Host_BytesReceived(&VirtualSerial_CDC_Interface))
 117         {
 118                 /* Echo received bytes from the attached device through the USART */
 119                 int16_t ReceivedByte = CDC_Host_ReceiveByte(&VirtualSerial_CDC_Interface);
 120                 if (!(ReceivedByte < 0))
 121                   putchar(ReceivedByte);
 122         }
 123 }
 124
 125 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 126  *  starts the library USB task to begin the enumeration and USB management process.
 127  */
 128 void EVENT_USB_Host_DeviceAttached(void)
 129 {
 130         puts_P(PSTR("Device Attached.\r\n"));
 131         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 132 }
 133
 134 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 135  *  stops the library USB task management process.
 136  */
 137 void EVENT_USB_Host_DeviceUnattached(void)
 138 {
 139         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 140         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 141 }
 142
 143 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 144  *  enumerated by the host and is now ready to be used by the application.
 145  */
 146 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 147 {
 148         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 149
 150         uint16_t ConfigDescriptorSize;
 151         uint8_t  ConfigDescriptorData[512];
 152
 153         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 154                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 155         {
 156                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 157                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 158                 return;
 159         }
 160
 161         if (CDC_Host_ConfigurePipes(&VirtualSerial_CDC_Interface,
 162                                     ConfigDescriptorSize, ConfigDescriptorData) != CDC_ENUMERROR_NoError)
 163         {
 164                 puts_P(PSTR("Attached Device Not a Valid CDC Class Device.\r\n"));
 165                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 166                 return;
 167         }
 168
 169         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 170         {
 171                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 172                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 173                 return;
 174         }
 175
 176         VirtualSerial_CDC_Interface.State.LineEncoding.BaudRateBPS = 9600;
 177         VirtualSerial_CDC_Interface.State.LineEncoding.CharFormat  = CDC_LINEENCODING_OneStopBit;
 178         VirtualSerial_CDC_Interface.State.LineEncoding.ParityType  = CDC_PARITY_None;
 179         VirtualSerial_CDC_Interface.State.LineEncoding.DataBits    = 8;
 180
 181         if (CDC_Host_SetLineEncoding(&VirtualSerial_CDC_Interface))
 182         {
 183                 puts_P(PSTR("Error Setting Device Line Encoding.\r\n"));
 184                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 185                 return;
 186         }
 187
 188         puts_P(PSTR("CDC Device Enumerated.\r\n"));
 189         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 190 }
 191
 192 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 193 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 194 {
 195         USB_Disable();
 196
 197         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 198                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 199
 200         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 201         for(;;);
 202 }
 203
 204 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 205  *  enumerating an attached USB device.
 206  */
 207 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 208                                             const uint8_t SubErrorCode)
 209 {
 210         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 211                                  " -- Error Code %d\r\n"
 212                                  " -- Sub Error Code %d\r\n"
 213                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 214
 215         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 216 }
 217