Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2016.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2016  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 disclaims 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 KeyboardHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "KeyboardHost.h"
  38
  39 /** LUFA HID Class driver interface configuration and state information. This structure is
  40  *  passed to all HID Class driver functions, so that multiple instances of the same class
  41  *  within a device can be differentiated from one another.
  42  */
  43 USB_ClassInfo_HID_Host_t Keyboard_HID_Interface =
  44         {
  45                 .Config =
  46                         {
  47                                 .DataINPipe             =
  48                                         {
  49                                                 .Address        = (PIPE_DIR_IN  | 1),
  50                                                 .Banks          = 1,
  51                                         },
  52                                 .DataOUTPipe            =
  53                                         {
  54                                                 .Address        = (PIPE_DIR_OUT | 2),
  55                                                 .Banks          = 1,
  56                                         },
  57                                 .HIDInterfaceProtocol   = HID_CSCP_KeyboardBootProtocol,
  58                         },
  59         };
  60
  61
  62 /** Main program entry point. This routine configures the hardware required by the application, then
  63  *  enters a loop to run the application tasks in sequence.
  64  */
  65 int main(void)
  66 {
  67         SetupHardware();
  68
  69         puts_P(PSTR(ESC_FG_CYAN "Keyboard Host Demo running.\r\n" ESC_FG_WHITE));
  70
  71         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  72         GlobalInterruptEnable();
  73
  74         for (;;)
  75         {
  76                 KeyboardHost_Task();
  77
  78                 HID_Host_USBTask(&Keyboard_HID_Interface);
  79                 USB_USBTask();
  80         }
  81 }
  82
  83 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  84 void SetupHardware(void)
  85 {
  86 #if (ARCH == ARCH_AVR8)
  87         /* Disable watchdog if enabled by bootloader/fuses */
  88         MCUSR &= ~(1 << WDRF);
  89         wdt_disable();
  90
  91         /* Disable clock division */
  92         clock_prescale_set(clock_div_1);
  93 #endif
  94
  95         /* Hardware Initialization */
  96         Serial_Init(9600, false);
  97         LEDs_Init();
  98         USB_Init();
  99
 100         /* Create a stdio stream for the serial port for stdin and stdout */
 101         Serial_CreateStream(NULL);
 102 }
 103
 104 /** Task to manage an enumerated USB keyboard once connected, to display key state
 105  *  data as it is received.
 106  */
 107 void KeyboardHost_Task(void)
 108 {
 109         if (USB_HostState != HOST_STATE_Configured)
 110           return;
 111
 112         if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))
 113         {
 114                 USB_KeyboardReport_Data_t KeyboardReport;
 115                 HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
 116
 117                 LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 118
 119                 uint8_t KeyCode = KeyboardReport.KeyCode[0];
 120
 121                 if (KeyCode)
 122                 {
 123                         char PressedKey = 0;
 124
 125                         LEDs_ToggleLEDs(LEDS_LED2);
 126
 127                         /* Retrieve pressed key character if alphanumeric */
 128                         if ((KeyCode >= HID_KEYBOARD_SC_A) && (KeyCode <= HID_KEYBOARD_SC_Z))
 129                         {
 130                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_A) + 'A';
 131                         }
 132                         else if ((KeyCode >= HID_KEYBOARD_SC_1_AND_EXCLAMATION) &
 133                                  (KeyCode  < HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS))
 134                         {
 135                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_1_AND_EXCLAMATION) + '1';
 136                         }
 137                         else if (KeyCode == HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS)
 138                         {
 139                                 PressedKey = '0';
 140                         }
 141                         else if (KeyCode == HID_KEYBOARD_SC_SPACE)
 142                         {
 143                                 PressedKey = ' ';
 144                         }
 145                         else if (KeyCode == HID_KEYBOARD_SC_ENTER)
 146                         {
 147                                 PressedKey = '\n';
 148                         }
 149
 150                         if (PressedKey)
 151                           putchar(PressedKey);
 152                 }
 153         }
 154 }
 155
 156 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 157  *  starts the library USB task to begin the enumeration and USB management process.
 158  */
 159 void EVENT_USB_Host_DeviceAttached(void)
 160 {
 161         puts_P(PSTR("Device Attached.\r\n"));
 162         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 163 }
 164
 165 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 166  *  stops the library USB task management process.
 167  */
 168 void EVENT_USB_Host_DeviceUnattached(void)
 169 {
 170         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 171         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 172 }
 173
 174 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 175  *  enumerated by the host and is now ready to be used by the application.
 176  */
 177 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 178 {
 179         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 180
 181         uint16_t ConfigDescriptorSize;
 182         uint8_t  ConfigDescriptorData[512];
 183
 184         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 185                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 186         {
 187                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 188                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 189                 return;
 190         }
 191
 192         if (HID_Host_ConfigurePipes(&Keyboard_HID_Interface,
 193                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 194         {
 195                 puts_P(PSTR("Attached Device Not a Valid Keyboard.\r\n"));
 196                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 197                 return;
 198         }
 199
 200         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 201         {
 202                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 203                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 204                 return;
 205         }
 206
 207         if (HID_Host_SetBootProtocol(&Keyboard_HID_Interface) != 0)
 208         {
 209                 puts_P(PSTR("Could not Set Boot Protocol Mode.\r\n"));
 210                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 211                 USB_Host_SetDeviceConfiguration(0);
 212                 return;
 213         }
 214
 215         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 216         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 217 }
 218
 219 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 220 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 221 {
 222         USB_Disable();
 223
 224         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 225                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 226
 227         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 228         for(;;);
 229 }
 230
 231 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 232  *  enumerating an attached USB device.
 233  */
 234 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 235                                             const uint8_t SubErrorCode)
 236 {
 237         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 238                                  " -- Error Code %d\r\n"
 239                                  " -- Sub Error Code %d\r\n"
 240                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 241
 242         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 243 }
 244