Demos/CDCHost/CDCHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 CDCHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "CDCHost.h"
  38
  39 /* Project Tags, for reading out using the ButtLoad project */
  40 BUTTLOADTAG(ProjName,    "LUFA CDC Host App");
  41 BUTTLOADTAG(BuildTime,   __TIME__);
  42 BUTTLOADTAG(BuildDate,   __DATE__);
  43 BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);
  44
  45 /* Scheduler Task List */
  46 TASK_LIST
  47 {
  48         { Task: USB_USBTask          , TaskStatus: TASK_STOP },
  49         { Task: USB_CDC_Host         , TaskStatus: TASK_STOP },
  50 };
  51
  52
  53 /** Main program entry point. This routine configures the hardware required by the application, then
  54  *  starts the scheduler to run the application tasks.
  55  */
  56 int main(void)
  57 {
  58         /* Disable watchdog if enabled by bootloader/fuses */
  59         MCUSR &= ~(1 << WDRF);
  60         wdt_disable();
  61
  62         /* Disable Clock Division */
  63         SetSystemClockPrescaler(0);
  64
  65         /* Hardware Initialization */
  66         SerialStream_Init(9600, false);
  67         LEDs_Init();
  68
  69         /* Indicate USB not ready */
  70         UpdateStatus(Status_USBNotReady);
  71
  72         /* Initialize Scheduler so that it can be used */
  73         Scheduler_Init();
  74
  75         /* Initialize USB Subsystem */
  76         USB_Init();
  77
  78         /* Startup message */
  79         puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
  80                "CDC Host Demo running.\r\n" ESC_INVERSE_OFF));
  81
  82         /* Scheduling - routine never returns, so put this last in the main function */
  83         Scheduler_Start();
  84 }
  85
  86 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  87  *  starts the library USB task to begin the enumeration and USB management process.
  88  */
  89 EVENT_HANDLER(USB_DeviceAttached)
  90 {
  91         puts_P(PSTR("Device Attached.\r\n"));
  92         UpdateStatus(Status_USBEnumerating);
  93
  94         /* Start USB management task to enumerate the device */
  95         Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
  96 }
  97
  98 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  99  *  stops the library USB task management process.
 100  */
 101 EVENT_HANDLER(USB_DeviceUnattached)
 102 {
 103         /* Stop keyboard and USB management task */
 104         Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
 105         Scheduler_SetTaskMode(USB_CDC_Host, TASK_STOP);
 106
 107         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 108         UpdateStatus(Status_USBNotReady);
 109 }
 110
 111 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 112  *  enumerated by the host and is now ready to be used by the application.
 113  */
 114 EVENT_HANDLER(USB_DeviceEnumerationComplete)
 115 {
 116         /* Start CDC Host task */
 117         Scheduler_SetTaskMode(USB_CDC_Host, TASK_RUN);
 118
 119         /* Indicate device enumeration complete */
 120         UpdateStatus(Status_USBReady);
 121 }
 122
 123 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 124 EVENT_HANDLER(USB_HostError)
 125 {
 126         USB_ShutDown();
 127
 128         puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
 129         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 130
 131         UpdateStatus(Status_HardwareError);
 132         for(;;);
 133 }
 134
 135 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
 136  *  enumerating an attached USB device.
 137  */
 138 EVENT_HANDLER(USB_DeviceEnumerationFailed)
 139 {
 140         puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
 141         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 142         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 143         printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);
 144
 145         UpdateStatus(Status_EnumerationError);
 146 }
 147
 148 /** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
 149  *  log to a serial port, or anything else that is suitable for status updates.
 150  *
 151  *  \param CurrentStatus  Current status of the system, from the CDCHost_StatusCodes_t enum
 152  */
 153 void UpdateStatus(uint8_t CurrentStatus)
 154 {
 155         uint8_t LEDMask = LEDS_NO_LEDS;
 156
 157         /* Set the LED mask to the appropriate LED mask based on the given status code */
 158         switch (CurrentStatus)
 159         {
 160                 case Status_USBNotReady:
 161                         LEDMask = (LEDS_LED1);
 162                         break;
 163                 case Status_USBEnumerating:
 164                         LEDMask = (LEDS_LED1 | LEDS_LED2);
 165                         break;
 166                 case Status_USBReady:
 167                         LEDMask = (LEDS_LED2);
 168                         break;
 169                 case Status_EnumerationError:
 170                 case Status_HardwareError:
 171                         LEDMask = (LEDS_LED1 | LEDS_LED3);
 172                         break;
 173         }
 174
 175         /* Set the board LEDs to the new LED mask */
 176         LEDs_SetAllLEDs(LEDMask);
 177 }
 178
 179 /** Task to set the configuration of the attached device after it has been enumerated, and to read in
 180  *  data received from the attached CDC device and print it to the serial port.
 181  */
 182 TASK(USB_CDC_Host)
 183 {
 184         uint8_t ErrorCode;
 185
 186         switch (USB_HostState)
 187         {
 188                 case HOST_STATE_Addressed:
 189                         /* Standard request to set the device configuration to configuration 1 */
 190                         USB_HostRequest = (USB_Host_Request_Header_t)
 191                                 {
 192                                         bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 193                                         bRequest:      REQ_SetConfiguration,
 194                                         wValue:        1,
 195                                         wIndex:        0,
 196                                         wLength:       0,
 197                                 };
 198
 199                         /* Send the request, display error and wait for device detatch if request fails */
 200                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 201                         {
 202                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 203                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 204
 205                                 /* Indicate error via status LEDs */
 206                                 UpdateStatus(Status_EnumerationError);
 207
 208                                 /* Wait until USB device disconnected */
 209                                 while (USB_IsConnected);
 210                                 break;
 211                         }
 212
 213                         USB_HostState = HOST_STATE_Configured;
 214                         break;
 215                 case HOST_STATE_Configured:
 216                         puts_P(PSTR("Getting Config Data.\r\n"));
 217
 218                         /* Get and process the configuration descriptor data */
 219                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 220                         {
 221                                 if (ErrorCode == ControlError)
 222                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 223                                 else
 224                                   puts_P(PSTR("Invalid Device.\r\n"));
 225
 226                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 227
 228                                 /* Indicate error via status LEDs */
 229                                 UpdateStatus(Status_EnumerationError);
 230
 231                                 /* Wait until USB device disconnected */
 232                                 while (USB_IsConnected);
 233                                 break;
 234                         }
 235
 236                         puts_P(PSTR("CDC Device Enumerated.\r\n"));
 237
 238                         USB_HostState = HOST_STATE_Ready;
 239                         break;
 240                 case HOST_STATE_Ready:
 241                         /* Select and the data IN pipe */
 242                         Pipe_SelectPipe(CDC_DATAPIPE_IN);
 243
 244                         /* Check if data is in the pipe */
 245                         if (Pipe_ReadWriteAllowed())
 246                         {
 247                                 /* Get the length of the pipe data, and create a new buffer to hold it */
 248                                 uint16_t BufferLength = Pipe_BytesInPipe();
 249                                 uint8_t Buffer[BufferLength];
 250
 251                                 /* Read in the pipe data to the tempoary buffer */
 252                                 Pipe_Read_Stream_LE(Buffer, BufferLength);
 253
 254                                 /* Clear the pipe after it is read, ready for the next packet */
 255                                 Pipe_ClearCurrentBank();
 256
 257                                 /* Print out the buffer contents to the USART */
 258                                 for (uint16_t BufferByte = 0; BufferByte < BufferLength; BufferByte++)
 259                                   putchar(Buffer[BufferByte]);
 260                         }
 261
 262                         /* Select and unfreeze the notification pipe */
 263                         Pipe_SelectPipe(CDC_NOTIFICATIONPIPE);
 264                         Pipe_Unfreeze();
 265
 266                         /* Check if data is in the pipe */
 267                         if (Pipe_ReadWriteAllowed())
 268                         {
 269                                 /* Discard the event notification */
 270                                 Pipe_ClearCurrentBank();
 271                         }
 272
 273                         /* Freeze notification IN pipe after use */
 274                         Pipe_Freeze();
 275
 276                         break;
 277         }
 278 }