Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.c

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