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         /* Disable watchdog if enabled by bootloader/fuses */
  91         MCUSR &= ~(1 << WDRF);
  92         wdt_disable();
  93
  94         /* Disable clock division */
  95         clock_prescale_set(clock_div_1);
  96
  97         /* Hardware Initialization */
  98         Serial_Init(9600, false);
  99         LEDs_Init();
 100         USB_Init();
 101
 102         /* Create a stdio stream for the serial port for stdin and stdout */
 103         Serial_CreateStream(NULL);
 104 }
 105
 106 /** Task to manage an enumerated USB CDC device once connected, to print received data
 107  *  from the device to the serial port.
 108  */
 109 void CDCHost_Task(void)
 110 {
 111         if (USB_HostState != HOST_STATE_Configured)
 112           return;
 113
 114         if (CDC_Host_BytesReceived(&VirtualSerial_CDC_Interface))
 115         {
 116                 /* Echo received bytes from the attached device through the USART */
 117                 int16_t ReceivedByte = CDC_Host_ReceiveByte(&VirtualSerial_CDC_Interface);
 118                 if (!(ReceivedByte < 0))
 119                   putchar(ReceivedByte);
 120         }
 121 }
 122
 123 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 124  *  starts the library USB task to begin the enumeration and USB management process.
 125  */
 126 void EVENT_USB_Host_DeviceAttached(void)
 127 {
 128         puts_P(PSTR("Device Attached.\r\n"));
 129         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 130 }
 131
 132 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 133  *  stops the library USB task management process.
 134  */
 135 void EVENT_USB_Host_DeviceUnattached(void)
 136 {
 137         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 138         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 139 }
 140
 141 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 142  *  enumerated by the host and is now ready to be used by the application.
 143  */
 144 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 145 {
 146         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 147
 148         uint16_t ConfigDescriptorSize;
 149         uint8_t  ConfigDescriptorData[512];
 150
 151         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 152                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 153         {
 154                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 155                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 156                 return;
 157         }
 158
 159         if (CDC_Host_ConfigurePipes(&VirtualSerial_CDC_Interface,
 160                                     ConfigDescriptorSize, ConfigDescriptorData) != CDC_ENUMERROR_NoError)
 161         {
 162                 puts_P(PSTR("Attached Device Not a Valid CDC Class Device.\r\n"));
 163                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 164                 return;
 165         }
 166
 167         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 168         {
 169                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 170                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 171                 return;
 172         }
 173
 174         VirtualSerial_CDC_Interface.State.LineEncoding.BaudRateBPS = 9600;
 175         VirtualSerial_CDC_Interface.State.LineEncoding.CharFormat  = CDC_LINEENCODING_OneStopBit;
 176         VirtualSerial_CDC_Interface.State.LineEncoding.ParityType  = CDC_PARITY_None;
 177         VirtualSerial_CDC_Interface.State.LineEncoding.DataBits    = 8;
 178
 179         if (CDC_Host_SetLineEncoding(&VirtualSerial_CDC_Interface))
 180         {
 181                 puts_P(PSTR("Error Setting Device Line Encoding.\r\n"));
 182                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 183                 return;
 184         }
 185
 186         puts_P(PSTR("CDC Device Enumerated.\r\n"));
 187         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 188 }
 189
 190 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 191 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 192 {
 193         USB_Disable();
 194
 195         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 196                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 197
 198         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 199         for(;;);
 200 }
 201
 202 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 203  *  enumerating an attached USB device.
 204  */
 205 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 206                                             const uint8_t SubErrorCode)
 207 {
 208         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 209                                  " -- Error Code %d\r\n"
 210                                  " -- Sub Error Code %d\r\n"
 211                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 212
 213         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 214 }
 215