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, const uint8_t SubErrorCode)
 116 {
 117         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 118                                  " -- Error Code %d\r\n"
 119                                  " -- Sub Error Code %d\r\n"
 120                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 121
 122         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 123 }
 124
 125 /** Reads in and processes the next report from the attached device, displaying the report
 126  *  contents on the board LEDs and via the serial port.
 127  */
 128 void ReadNextReport(void)
 129 {
 130         /* Select and unfreeze HID data IN pipe */
 131         Pipe_SelectPipe(HID_DATA_IN_PIPE);
 132         Pipe_Unfreeze();
 133
 134         /* Check to see if a packet has been received */
 135         if (!(Pipe_IsINReceived()))
 136         {
 137                 /* Refreeze HID data IN pipe */
 138                 Pipe_Freeze();
 139
 140                 return;
 141         }
 142
 143         /* Ensure pipe contains data before trying to read from it */
 144         if (Pipe_IsReadWriteAllowed())
 145         {
 146                 uint8_t ReportINData[Pipe_BytesInPipe()];
 147
 148                 /* Read in HID report data */
 149                 Pipe_Read_Stream_LE(&ReportINData, sizeof(ReportINData));
 150
 151                 /* Print report data through the serial port */
 152                 for (uint16_t CurrByte = 0; CurrByte < sizeof(ReportINData); CurrByte++)
 153                   printf_P(PSTR("0x%02X "), ReportINData[CurrByte]);
 154
 155                 puts_P(PSTR("\r\n"));
 156         }
 157
 158         /* Clear the IN endpoint, ready for next data packet */
 159         Pipe_ClearIN();
 160
 161         /* Refreeze HID data IN pipe */
 162         Pipe_Freeze();
 163 }
 164
 165 /** Writes a report to the attached device.
 166  *
 167  *  \param[in] ReportOUTData  Buffer containing the report to send to the device
 168  *  \param[in] ReportIndex  Index of the report in the device (zero if the device does not use multiple reports)
 169  *  \param[in] ReportType  Type of report to send, either REPORT_TYPE_OUT or REPORT_TYPE_FEATURE
 170  *  \param[in] ReportLength  Length of the report to send
 171  */
 172 void WriteNextReport(uint8_t* ReportOUTData, uint8_t ReportIndex, uint8_t ReportType, uint16_t ReportLength)
 173 {
 174         /* Select the HID data OUT pipe */
 175         Pipe_SelectPipe(HID_DATA_OUT_PIPE);
 176
 177         /* Not all HID devices have an OUT endpoint (some require OUT reports to be sent over the
 178          * control endpoint instead) - check to see if the OUT endpoint has been initialized */
 179         if (Pipe_IsConfigured() && (ReportType == REPORT_TYPE_OUT))
 180         {
 181                 Pipe_Unfreeze();
 182
 183                 /* Ensure pipe is ready to be written to before continuing */
 184                 if (!(Pipe_IsOUTReady()))
 185                 {
 186                         /* Refreeze the data OUT pipe */
 187                         Pipe_Freeze();
 188
 189                         return;
 190                 }
 191
 192                 /* If the report index is used, send it before the report data */
 193                 if (ReportIndex)
 194                   Pipe_Write_Byte(ReportIndex);
 195
 196                 /* Write out HID report data */
 197                 Pipe_Write_Stream_LE(ReportOUTData, ReportLength);
 198
 199                 /* Clear the OUT endpoint, send last data packet */
 200                 Pipe_ClearOUT();
 201
 202                 /* Refreeze the data OUT pipe */
 203                 Pipe_Freeze();
 204         }
 205         else
 206         {
 207                 /* Class specific request to send a HID report to the device */
 208                 USB_ControlRequest = (USB_Request_Header_t)
 209                         {
 210                                 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 211                                 .bRequest      = REQ_SetReport,
 212                                 .wValue        = ((ReportType << 8) | ReportIndex),
 213                                 .wIndex        = 0,
 214                                 .wLength       = ReportLength,
 215                         };
 216
 217                 /* Select the control pipe for the request transfer */
 218                 Pipe_SelectPipe(PIPE_CONTROLPIPE);
 219
 220                 /* Send the request to the device */
 221                 USB_Host_SendControlRequest(ReportOUTData);
 222         }
 223 }
 224
 225 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 226  *  HID reports from the device and to send reports if desired.
 227  */
 228 void HID_Host_Task(void)
 229 {
 230         uint8_t ErrorCode;
 231
 232         /* Switch to determine what user-application handled host state the host state machine is in */
 233         switch (USB_HostState)
 234         {
 235                 case HOST_STATE_Addressed:
 236                         puts_P(PSTR("Getting Config Data.\r\n"));
 237
 238                         /* Get and process the configuration descriptor data */
 239                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 240                         {
 241                                 if (ErrorCode == ControlError)
 242                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 243                                 else
 244                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 245
 246                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 247
 248                                 /* Indicate error status */
 249                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 250
 251                                 /* Wait until USB device disconnected */
 252                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 253                                 break;
 254                         }
 255
 256                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 257                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 258                         {
 259                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 260                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 261
 262                                 /* Indicate error status */
 263                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 264
 265                                 /* Wait until USB device disconnected */
 266                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 267                                 break;
 268                         }
 269
 270                         puts_P(PSTR("HID Device Enumerated.\r\n"));
 271
 272                         USB_HostState = HOST_STATE_Configured;
 273                         break;
 274                 case HOST_STATE_Configured:
 275                         ReadNextReport();
 276
 277                         break;
 278         }
 279 }