Demos/Host/ClassDriver/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 /* Scheduler Task List */
  40 TASK_LIST
  41 {
  42         { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },
  43         { .Task = USB_CDC_Host         , .TaskStatus = TASK_STOP },
  44 };
  45
  46
  47 /** Main program entry point. This routine configures the hardware required by the application, then
  48  *  starts the scheduler to run the application tasks.
  49  */
  50 int main(void)
  51 {
  52         /* Disable watchdog if enabled by bootloader/fuses */
  53         MCUSR &= ~(1 << WDRF);
  54         wdt_disable();
  55
  56         /* Disable clock division */
  57         clock_prescale_set(clock_div_1);
  58
  59         /* Hardware Initialization */
  60         SerialStream_Init(9600, false);
  61         LEDs_Init();
  62
  63         /* Indicate USB not ready */
  64         UpdateStatus(Status_USBNotReady);
  65
  66         /* Initialize Scheduler so that it can be used */
  67         Scheduler_Init();
  68
  69         /* Initialize USB Subsystem */
  70         USB_Init();
  71
  72         /* Start-up message */
  73         puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
  74                "CDC Host Demo running.\r\n" ESC_INVERSE_OFF));
  75
  76         /* Scheduling - routine never returns, so put this last in the main function */
  77         Scheduler_Start();
  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_DeviceAttached(void)
  84 {
  85         puts_P(PSTR("Device Attached.\r\n"));
  86         UpdateStatus(Status_USBEnumerating);
  87
  88         /* Start USB management task to enumerate the device */
  89         Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
  90 }
  91
  92 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  93  *  stops the library USB task management process.
  94  */
  95 void EVENT_USB_DeviceUnattached(void)
  96 {
  97         /* Stop keyboard and USB management task */
  98         Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
  99         Scheduler_SetTaskMode(USB_CDC_Host, TASK_STOP);
 100
 101         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 102         UpdateStatus(Status_USBNotReady);
 103 }
 104
 105 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 106  *  enumerated by the host and is now ready to be used by the application.
 107  */
 108 void EVENT_USB_DeviceEnumerationComplete(void)
 109 {
 110         /* Start CDC Host task */
 111         Scheduler_SetTaskMode(USB_CDC_Host, TASK_RUN);
 112
 113         /* Indicate device enumeration complete */
 114         UpdateStatus(Status_USBReady);
 115 }
 116
 117 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 118 void EVENT_USB_HostError(const uint8_t ErrorCode)
 119 {
 120         USB_ShutDown();
 121
 122         puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
 123         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 124
 125         UpdateStatus(Status_HardwareError);
 126         for(;;);
 127 }
 128
 129 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 130  *  enumerating an attached USB device.
 131  */
 132 void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 133 {
 134         puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
 135         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 136         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 137         printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);
 138
 139         UpdateStatus(Status_EnumerationError);
 140 }
 141
 142 /** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
 143  *  log to a serial port, or anything else that is suitable for status updates.
 144  *
 145  *  \param CurrentStatus  Current status of the system, from the CDCHost_StatusCodes_t enum
 146  */
 147 void UpdateStatus(uint8_t CurrentStatus)
 148 {
 149         uint8_t LEDMask = LEDS_NO_LEDS;
 150
 151         /* Set the LED mask to the appropriate LED mask based on the given status code */
 152         switch (CurrentStatus)
 153         {
 154                 case Status_USBNotReady:
 155                         LEDMask = (LEDS_LED1);
 156                         break;
 157                 case Status_USBEnumerating:
 158                         LEDMask = (LEDS_LED1 | LEDS_LED2);
 159                         break;
 160                 case Status_USBReady:
 161                         LEDMask = (LEDS_LED2);
 162                         break;
 163                 case Status_EnumerationError:
 164                 case Status_HardwareError:
 165                         LEDMask = (LEDS_LED1 | LEDS_LED3);
 166                         break;
 167         }
 168
 169         /* Set the board LEDs to the new LED mask */
 170         LEDs_SetAllLEDs(LEDMask);
 171 }
 172
 173 /** Task to set the configuration of the attached device after it has been enumerated, and to read in
 174  *  data received from the attached CDC device and print it to the serial port.
 175  */
 176 TASK(USB_CDC_Host)
 177 {
 178         uint8_t ErrorCode;
 179
 180         switch (USB_HostState)
 181         {
 182                 case HOST_STATE_Addressed:
 183                         /* Standard request to set the device configuration to configuration 1 */
 184                         USB_ControlRequest = (USB_Request_Header_t)
 185                                 {
 186                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 187                                         .bRequest      = REQ_SetConfiguration,
 188                                         .wValue        = 1,
 189                                         .wIndex        = 0,
 190                                         .wLength       = 0,
 191                                 };
 192
 193                         /* Select the control pipe for the request transfer */
 194                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 195
 196                         /* Send the request, display error and wait for device detach if request fails */
 197                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 198                         {
 199                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 200                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 201
 202                                 /* Indicate error via status LEDs */
 203                                 UpdateStatus(Status_EnumerationError);
 204
 205                                 /* Wait until USB device disconnected */
 206                                 while (USB_IsConnected);
 207                                 break;
 208                         }
 209
 210                         USB_HostState = HOST_STATE_Configured;
 211                         break;
 212                 case HOST_STATE_Configured:
 213                         puts_P(PSTR("Getting Config Data.\r\n"));
 214
 215                         /* Get and process the configuration descriptor data */
 216                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 217                         {
 218                                 if (ErrorCode == ControlError)
 219                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 220                                 else
 221                                   puts_P(PSTR("Invalid Device.\r\n"));
 222
 223                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 224
 225                                 /* Indicate error via status LEDs */
 226                                 UpdateStatus(Status_EnumerationError);
 227
 228                                 /* Wait until USB device disconnected */
 229                                 while (USB_IsConnected);
 230                                 break;
 231                         }
 232
 233                         puts_P(PSTR("CDC Device Enumerated.\r\n"));
 234
 235                         USB_HostState = HOST_STATE_Ready;
 236                         break;
 237                 case HOST_STATE_Ready:
 238                         /* Select and the data IN pipe */
 239                         Pipe_SelectPipe(CDC_DATAPIPE_IN);
 240
 241                         /* Check to see if a packet has been received */
 242                         if (Pipe_IsINReceived())
 243                         {
 244                                 /* Check if data is in the pipe */
 245                                 if (Pipe_IsReadWriteAllowed())
 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 temporary buffer */
 252                                         Pipe_Read_Stream_LE(Buffer, BufferLength);
 253
 254                                         /* Print out the buffer contents to the USART */
 255                                         for (uint16_t BufferByte = 0; BufferByte < BufferLength; BufferByte++)
 256                                           putchar(Buffer[BufferByte]);
 257                                 }
 258
 259                                 /* Clear the pipe after it is read, ready for the next packet */
 260                                 Pipe_ClearIN();
 261                         }
 262
 263                         /* Select and unfreeze the notification pipe */
 264                         Pipe_SelectPipe(CDC_NOTIFICATIONPIPE);
 265                         Pipe_Unfreeze();
 266
 267                         /* Check if a packet has been received */
 268                         if (Pipe_IsINReceived())
 269                         {
 270                                 /* Discard the unused event notification */
 271                                 Pipe_ClearIN();
 272                         }
 273
 274                         /* Freeze notification IN pipe after use */
 275                         Pipe_Freeze();
 276
 277                         break;
 278         }
 279 }