Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.c

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