Demos/Host/GenericHIDHost/GenericHIDHost.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 GenericHIDHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "GenericHIDHost.h"
  38
  39 /* Scheduler Task List */
  40 TASK_LIST
  41 {
  42         { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },
  43         { .Task = USB_HID_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                "Generic HID 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 EVENT_HANDLER(USB_DeviceAttached)
  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 EVENT_HANDLER(USB_DeviceUnattached)
  96 {
  97         /* Stop HID and USB management task */
  98         Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
  99         Scheduler_SetTaskMode(USB_HID_Host, TASK_STOP);
 100
 101         puts_P(PSTR("Device 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 EVENT_HANDLER(USB_DeviceEnumerationComplete)
 109 {
 110         /* Start HID Host task */
 111         Scheduler_SetTaskMode(USB_HID_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 EVENT_HANDLER(USB_HostError)
 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 EVENT_HANDLER(USB_DeviceEnumerationFailed)
 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 GenericHIDHost_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 /** Reads in and processes the next report from the attached device, displaying the report
 174  *  contents on the board LEDs and via the serial port.
 175  */
 176 void ReadNextReport(void)
 177 {
 178         /* Select and unfreeze HID data IN pipe */
 179         Pipe_SelectPipe(HID_DATA_IN_PIPE);
 180         Pipe_Unfreeze();
 181
 182         /* Check to see if a packet has been received */
 183         if (!(Pipe_IsINReceived()))
 184         {
 185                 #if !defined(INTERRUPT_DATA_PIPE)
 186                 /* Refreeze HID data IN pipe */
 187                 Pipe_Freeze();
 188                 #endif
 189
 190                 return;
 191         }
 192
 193         /* Ensure pipe contains data before trying to read from it */
 194         if (Pipe_IsReadWriteAllowed())
 195         {
 196                 uint8_t ReportINData[Pipe_BytesInPipe()];
 197
 198                 /* Read in HID report data */
 199                 Pipe_Read_Stream_LE(&ReportINData, sizeof(ReportINData));
 200
 201                 /* Print report data through the serial port */
 202                 for (uint16_t CurrByte = 0; CurrByte < sizeof(ReportINData); CurrByte++)
 203                   printf_P(PSTR("0x%02X "), ReportINData[CurrByte]);
 204
 205                 puts_P(PSTR("\r\n"));
 206         }
 207
 208         /* Clear the IN endpoint, ready for next data packet */
 209         Pipe_ClearIN();
 210
 211         #if !defined(INTERRUPT_DATA_PIPE)
 212         /* Refreeze HID data IN pipe */
 213         Pipe_Freeze();
 214         #endif
 215 }
 216
 217 /** Writes a report to the attached device.
 218  *
 219  *  \param ReportOUTData  Buffer containing the report to send to the device
 220  *  \param ReportIndex  Index of the report in the device (zero if the device does not use multiple reports)
 221  *  \param ReportType  Type of report to send, either HID_REPORTTYPE_OUTPUT or HID_REPORTTYPE_FEATURE
 222  *  \param ReportLength  Length of the report to send
 223  */
 224 void WriteNextReport(uint8_t* ReportOUTData, uint8_t ReportIndex, uint8_t ReportType, uint16_t ReportLength)
 225 {
 226         /* Select and unfreeze HID data OUT pipe */
 227         Pipe_SelectPipe(HID_DATA_OUT_PIPE);
 228
 229         /* Not all HID devices have an OUT endpoint (some require OUT reports to be sent over the
 230          * control endpoint instead) - check to see if the OUT endpoint has been initialized */
 231         if (Pipe_IsConfigured())
 232         {
 233                 Pipe_Unfreeze();
 234
 235                 /* Ensure pipe is ready to be written to before continuing */
 236                 if (!(Pipe_IsOUTReady()))
 237                 {
 238                         /* Refreeze the data OUT pipe */
 239                         Pipe_Freeze();
 240
 241                         return;
 242                 }
 243
 244                 /* If the report index is used, send it before the report data */
 245                 if (ReportIndex)
 246                   Pipe_Write_Byte(ReportIndex);
 247
 248                 /* Write out HID report data */
 249                 Pipe_Write_Stream_LE(ReportOUTData, ReportLength);
 250
 251                 /* Clear the OUT endpoint, send last data packet */
 252                 Pipe_ClearOUT();
 253
 254                 /* Refreeze the data OUT pipe */
 255                 Pipe_Freeze();
 256         }
 257         else
 258         {
 259                 /* Class specific request to send a HID report to the device */
 260                 USB_HostRequest = (USB_Host_Request_Header_t)
 261                         {
 262                                 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 263                                 .bRequest      = REQ_SetReport,
 264                                 .wValue        = ((ReportType << 8) | ReportIndex),
 265                                 .wIndex        = 0,
 266                                 .wLength       = ReportLength,
 267                         };
 268
 269                 /* Select the control pipe for the request transfer */
 270                 Pipe_SelectPipe(PIPE_CONTROLPIPE);
 271
 272                 /* Send the request to the device */
 273                 USB_Host_SendControlRequest(ReportOUTData);
 274         }
 275 }
 276
 277 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 278  *  HID reports from the device and to send reports if desired.
 279  */
 280 TASK(USB_HID_Host)
 281 {
 282         uint8_t ErrorCode;
 283
 284         /* Switch to determine what user-application handled host state the host state machine is in */
 285         switch (USB_HostState)
 286         {
 287                 case HOST_STATE_Addressed:
 288                         /* Standard request to set the device configuration to configuration 1 */
 289                         USB_HostRequest = (USB_Host_Request_Header_t)
 290                                 {
 291                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 292                                         .bRequest      = REQ_SetConfiguration,
 293                                         .wValue        = 1,
 294                                         .wIndex        = 0,
 295                                         .wLength       = 0,
 296                                 };
 297
 298                         /* Select the control pipe for the request transfer */
 299                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 300
 301                         /* Send the request, display error and wait for device detach if request fails */
 302                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 303                         {
 304                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 305                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 306
 307                                 /* Indicate error status */
 308                                 UpdateStatus(Status_EnumerationError);
 309
 310                                 /* Wait until USB device disconnected */
 311                                 while (USB_IsConnected);
 312                                 break;
 313                         }
 314
 315                         USB_HostState = HOST_STATE_Configured;
 316                         break;
 317                 case HOST_STATE_Configured:
 318                         puts_P(PSTR("Getting Config Data.\r\n"));
 319
 320                         /* Get and process the configuration descriptor data */
 321                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 322                         {
 323                                 if (ErrorCode == ControlError)
 324                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 325                                 else
 326                                   puts_P(PSTR("Invalid Device.\r\n"));
 327
 328                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 329
 330                                 /* Indicate error status */
 331                                 UpdateStatus(Status_EnumerationError);
 332
 333                                 /* Wait until USB device disconnected */
 334                                 while (USB_IsConnected);
 335                                 break;
 336                         }
 337
 338                         #if defined(INTERRUPT_DATA_PIPE)
 339                         /* Select and unfreeze HID data IN pipe */
 340                         Pipe_SelectPipe(HID_DATA_IN_PIPE);
 341                         Pipe_Unfreeze();
 342                         #endif
 343
 344                         puts_P(PSTR("HID Device Enumerated.\r\n"));
 345
 346                         USB_HostState = HOST_STATE_Ready;
 347                         break;
 348                 #if !defined(INTERRUPT_DATA_PIPE)
 349                 case HOST_STATE_Ready:
 350                         ReadNextReport();
 351
 352                         break;
 353                 #endif
 354         }
 355 }
 356
 357 #if defined(INTERRUPT_DATA_PIPE)
 358 /** Interrupt handler for the Endpoint/Pipe interrupt vector. This interrupt fires each time an enabled
 359  *  pipe interrupt occurs on a pipe which has had that interrupt enabled.
 360  */
 361 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
 362 {
 363         /* Save previously selected pipe before selecting a new pipe */
 364         uint8_t PrevSelectedPipe = Pipe_GetCurrentPipe();
 365
 366         /* Check to see if the HID data IN pipe has caused the interrupt */
 367         if (Pipe_HasPipeInterrupted(HID_DATA_IN_PIPE))
 368         {
 369                 /* Clear the pipe interrupt, and select the data IN pipe */
 370                 Pipe_ClearPipeInterrupt(HID_DATA_IN_PIPE);
 371                 Pipe_SelectPipe(HID_DATA_IN_PIPE);
 372
 373                 /* Check to see if the pipe IN interrupt has fired */
 374                 if (USB_INT_HasOccurred(PIPE_INT_IN) && USB_INT_IsEnabled(PIPE_INT_IN))
 375                 {
 376                         /* Clear interrupt flag */
 377                         USB_INT_Clear(PIPE_INT_IN);
 378
 379                         /* Read and process the next report from the device */
 380                         ReadNextReport();
 381                 }
 382         }
 383
 384         /* Restore previously selected pipe */
 385         Pipe_SelectPipe(PrevSelectedPipe);
 386 }
 387 #endif