Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 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 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_FG_CYAN "Generic HID Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         sei();
  50
  51         for (;;)
  52         {
  53                 HID_Host_Task();
  54                 USB_USBTask();
  55         }
  56 }
  57
  58 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  59 void SetupHardware(void)
  60 {
  61         /* Disable watchdog if enabled by bootloader/fuses */
  62         MCUSR &= ~(1 << WDRF);
  63         wdt_disable();
  64
  65         /* Disable clock division */
  66         clock_prescale_set(clock_div_1);
  67
  68         /* Hardware Initialization */
  69         SerialStream_Init(9600, false);
  70         LEDs_Init();
  71         USB_Init();
  72 }
  73
  74 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  75  *  starts the library USB task to begin the enumeration and USB management process.
  76  */
  77 void EVENT_USB_Host_DeviceAttached(void)
  78 {
  79         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  80         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  81 }
  82
  83 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  84  *  stops the library USB task management process.
  85  */
  86 void EVENT_USB_Host_DeviceUnattached(void)
  87 {
  88         puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
  89         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  90 }
  91
  92 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  93  *  enumerated by the host and is now ready to be used by the application.
  94  */
  95 void EVENT_USB_Host_DeviceEnumerationComplete(void)
  96 {
  97         LEDs_SetAllLEDs(LEDMASK_USB_READY);
  98 }
  99
 100 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 101 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 102 {
 103         USB_ShutDown();
 104
 105         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 106                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 107
 108         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 109         for(;;);
 110 }
 111
 112 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 113  *  enumerating an attached USB device.
 114  */
 115 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 116                                             const uint8_t SubErrorCode)
 117 {
 118         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 119                                  " -- Error Code %d\r\n"
 120                                  " -- Sub Error Code %d\r\n"
 121                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 122
 123         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 124 }
 125
 126 /** Reads in and processes the next report from the attached device, displaying the report
 127  *  contents on the board LEDs and via the serial port.
 128  */
 129 void ReadNextReport(void)
 130 {
 131         /* Select and unfreeze HID data IN pipe */
 132         Pipe_SelectPipe(HID_DATA_IN_PIPE);
 133         Pipe_Unfreeze();
 134
 135         /* Check to see if a packet has been received */
 136         if (!(Pipe_IsINReceived()))
 137         {
 138                 /* Refreeze HID data IN pipe */
 139                 Pipe_Freeze();
 140
 141                 return;
 142         }
 143
 144         /* Ensure pipe contains data before trying to read from it */
 145         if (Pipe_IsReadWriteAllowed())
 146         {
 147                 uint8_t ReportINData[Pipe_BytesInPipe()];
 148
 149                 /* Read in HID report data */
 150                 Pipe_Read_Stream_LE(&ReportINData, sizeof(ReportINData));
 151
 152                 /* Print report data through the serial port */
 153                 for (uint16_t CurrByte = 0; CurrByte < sizeof(ReportINData); CurrByte++)
 154                   printf_P(PSTR("0x%02X "), ReportINData[CurrByte]);
 155
 156                 puts_P(PSTR("\r\n"));
 157         }
 158
 159         /* Clear the IN endpoint, ready for next data packet */
 160         Pipe_ClearIN();
 161
 162         /* Refreeze HID data IN pipe */
 163         Pipe_Freeze();
 164 }
 165
 166 /** Writes a report to the attached device.
 167  *
 168  *  \param[in] ReportOUTData  Buffer containing the report to send to the device
 169  *  \param[in] ReportIndex    Index of the report in the device (zero if the device does not use multiple reports)
 170  *  \param[in] ReportType     Type of report to send, either REPORT_TYPE_OUT or REPORT_TYPE_FEATURE
 171  *  \param[in] ReportLength   Length of the report to send
 172  */
 173 void WriteNextReport(uint8_t* ReportOUTData,
 174                      const uint8_t ReportIndex,
 175                      const uint8_t ReportType,
 176                      uint16_t ReportLength)
 177 {
 178         /* Select the HID data OUT pipe */
 179         Pipe_SelectPipe(HID_DATA_OUT_PIPE);
 180
 181         /* Not all HID devices have an OUT endpoint (some require OUT reports to be sent over the
 182          * control endpoint instead) - check to see if the OUT endpoint has been initialized */
 183         if (Pipe_IsConfigured() && (ReportType == REPORT_TYPE_OUT))
 184         {
 185                 Pipe_Unfreeze();
 186
 187                 /* Ensure pipe is ready to be written to before continuing */
 188                 if (!(Pipe_IsOUTReady()))
 189                 {
 190                         /* Refreeze the data OUT pipe */
 191                         Pipe_Freeze();
 192
 193                         return;
 194                 }
 195
 196                 /* If the report index is used, send it before the report data */
 197                 if (ReportIndex)
 198                   Pipe_Write_Byte(ReportIndex);
 199
 200                 /* Write out HID report data */
 201                 Pipe_Write_Stream_LE(ReportOUTData, ReportLength);
 202
 203                 /* Clear the OUT endpoint, send last data packet */
 204                 Pipe_ClearOUT();
 205
 206                 /* Refreeze the data OUT pipe */
 207                 Pipe_Freeze();
 208         }
 209         else
 210         {
 211                 /* Class specific request to send a HID report to the device */
 212                 USB_ControlRequest = (USB_Request_Header_t)
 213                         {
 214                                 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 215                                 .bRequest      = REQ_SetReport,
 216                                 .wValue        = ((ReportType << 8) | ReportIndex),
 217                                 .wIndex        = 0,
 218                                 .wLength       = ReportLength,
 219                         };
 220
 221                 /* Select the control pipe for the request transfer */
 222                 Pipe_SelectPipe(PIPE_CONTROLPIPE);
 223
 224                 /* Send the request to the device */
 225                 USB_Host_SendControlRequest(ReportOUTData);
 226         }
 227 }
 228
 229 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 230  *  HID reports from the device and to send reports if desired.
 231  */
 232 void HID_Host_Task(void)
 233 {
 234         uint8_t ErrorCode;
 235
 236         /* Switch to determine what user-application handled host state the host state machine is in */
 237         switch (USB_HostState)
 238         {
 239                 case HOST_STATE_Addressed:
 240                         puts_P(PSTR("Getting Config Data.\r\n"));
 241
 242                         /* Get and process the configuration descriptor data */
 243                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 244                         {
 245                                 if (ErrorCode == ControlError)
 246                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 247                                 else
 248                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 249
 250                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 251
 252                                 /* Indicate error status */
 253                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 254
 255                                 /* Wait until USB device disconnected */
 256                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 257                                 break;
 258                         }
 259
 260                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 261                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 262                         {
 263                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 264                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 265
 266                                 /* Indicate error status */
 267                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 268
 269                                 /* Wait until USB device disconnected */
 270                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 271                                 break;
 272                         }
 273
 274                         puts_P(PSTR("HID Device Enumerated.\r\n"));
 275
 276                         USB_HostState = HOST_STATE_Configured;
 277                         break;
 278                 case HOST_STATE_Configured:
 279                         ReadNextReport();
 280
 281                         break;
 282         }
 283 }