Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.c

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