Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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         /* Disable watchdog if enabled by bootloader/fuses */
  87         MCUSR &= ~(1 << WDRF);
  88         wdt_disable();
  89
  90         /* Disable clock division */
  91         clock_prescale_set(clock_div_1);
  92
  93         /* Hardware Initialization */
  94         Serial_Init(9600, false);
  95         LEDs_Init();
  96         USB_Init();
  97
  98         /* Create a stdio stream for the serial port for stdin and stdout */
  99         Serial_CreateStream(NULL);
 100 }
 101
 102 /** Task to manage an enumerated USB keyboard once connected, to display key state
 103  *  data as it is received.
 104  */
 105 void KeyboardHost_Task(void)
 106 {
 107         if (USB_HostState != HOST_STATE_Configured)
 108           return;
 109
 110         if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))
 111         {
 112                 USB_KeyboardReport_Data_t KeyboardReport;
 113                 HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
 114
 115                 LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 116
 117                 uint8_t KeyCode = KeyboardReport.KeyCode[0];
 118
 119                 if (KeyCode)
 120                 {
 121                         char PressedKey = 0;
 122
 123                         LEDs_ToggleLEDs(LEDS_LED2);
 124
 125                         /* Retrieve pressed key character if alphanumeric */
 126                         if ((KeyCode >= HID_KEYBOARD_SC_A) && (KeyCode <= HID_KEYBOARD_SC_Z))
 127                         {
 128                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_A) + 'A';
 129                         }
 130                         else if ((KeyCode >= HID_KEYBOARD_SC_1_AND_EXCLAMATION) &
 131                                  (KeyCode  < HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS))
 132                         {
 133                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_1_AND_EXCLAMATION) + '1';
 134                         }
 135                         else if (KeyCode == HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS)
 136                         {
 137                                 PressedKey = '0';
 138                         }
 139                         else if (KeyCode == HID_KEYBOARD_SC_SPACE)
 140                         {
 141                                 PressedKey = ' ';
 142                         }
 143                         else if (KeyCode == HID_KEYBOARD_SC_ENTER)
 144                         {
 145                                 PressedKey = '\n';
 146                         }
 147
 148                         if (PressedKey)
 149                           putchar(PressedKey);
 150                 }
 151         }
 152 }
 153
 154 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 155  *  starts the library USB task to begin the enumeration and USB management process.
 156  */
 157 void EVENT_USB_Host_DeviceAttached(void)
 158 {
 159         puts_P(PSTR("Device Attached.\r\n"));
 160         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 161 }
 162
 163 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 164  *  stops the library USB task management process.
 165  */
 166 void EVENT_USB_Host_DeviceUnattached(void)
 167 {
 168         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 169         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 170 }
 171
 172 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 173  *  enumerated by the host and is now ready to be used by the application.
 174  */
 175 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 176 {
 177         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 178
 179         uint16_t ConfigDescriptorSize;
 180         uint8_t  ConfigDescriptorData[512];
 181
 182         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 183                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 184         {
 185                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 186                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 187                 return;
 188         }
 189
 190         if (HID_Host_ConfigurePipes(&Keyboard_HID_Interface,
 191                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 192         {
 193                 puts_P(PSTR("Attached Device Not a Valid Keyboard.\r\n"));
 194                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 195                 return;
 196         }
 197
 198         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 199         {
 200                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 201                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 202                 return;
 203         }
 204
 205         if (HID_Host_SetBootProtocol(&Keyboard_HID_Interface) != 0)
 206         {
 207                 puts_P(PSTR("Could not Set Boot Protocol Mode.\r\n"));
 208                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 209                 USB_Host_SetDeviceConfiguration(0);
 210                 return;
 211         }
 212
 213         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 214         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 215 }
 216
 217 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 218 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 219 {
 220         USB_Disable();
 221
 222         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 223                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 224
 225         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 226         for(;;);
 227 }
 228
 229 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 230  *  enumerating an attached USB device.
 231  */
 232 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 233                                             const uint8_t SubErrorCode)
 234 {
 235         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 236                                  " -- Error Code %d\r\n"
 237                                  " -- Sub Error Code %d\r\n"
 238                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 239
 240         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 241 }
 242