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