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