Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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                                 .DataOUTPipeNumber      = 2,
  49
  50                                 .HIDInterfaceProtocol   = HID_BOOT_KEYBOARD_PROTOCOL,
  51                         },
  52         };
  53
  54
  55 /** Main program entry point. This routine configures the hardware required by the application, then
  56  *  starts the scheduler to run the application tasks.
  57  */
  58 int main(void)
  59 {
  60         SetupHardware();
  61
  62         puts_P(PSTR(ESC_FG_CYAN "Keyboard Host Demo running.\r\n" ESC_FG_WHITE));
  63
  64         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  65
  66         for (;;)
  67         {
  68                 switch (USB_HostState)
  69                 {
  70                         case HOST_STATE_Addressed:
  71                                 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  72
  73                                 uint16_t ConfigDescriptorSize;
  74                                 uint8_t  ConfigDescriptorData[512];
  75
  76                                 if (USB_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
  77                                                                   sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
  78                                 {
  79                                         printf("Error Retrieving Configuration Descriptor.\r\n");
  80                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  81                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
  82                                         break;
  83                                 }
  84
  85                                 if (HID_Host_ConfigurePipes(&Keyboard_HID_Interface,
  86                                                             ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
  87                                 {
  88                                         printf("Attached Device Not a Valid Keyboard.\r\n");
  89                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  90                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
  91                                         break;
  92                                 }
  93
  94                                 if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
  95                                 {
  96                                         printf("Error Setting Device Configuration.\r\n");
  97                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  98                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
  99                                         break;
 100                                 }
 101
 102                                 if (HID_Host_SetBootProtocol(&Keyboard_HID_Interface) != 0)
 103                                 {
 104                                         printf("Could not Set Boot Protocol Mode.\r\n");
 105                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 106                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 107                                         break;
 108                                 }
 109
 110                                 printf("Keyboard Enumerated.\r\n");
 111                                 USB_HostState = HOST_STATE_Configured;
 112                                 break;
 113                         case HOST_STATE_Configured:
 114                                 if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))
 115                                 {
 116                                         USB_KeyboardReport_Data_t KeyboardReport;
 117                                         HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
 118
 119                                         LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 120
 121                                         uint8_t PressedKeyCode = KeyboardReport.KeyCode[0];
 122
 123                                         if (PressedKeyCode)
 124                                         {
 125                                                 char PressedKey = 0;
 126
 127                                                 LEDs_ToggleLEDs(LEDS_LED2);
 128
 129                                                 /* Retrieve pressed key character if alphanumeric */
 130                                                 if ((PressedKeyCode >= 0x04) && (PressedKeyCode <= 0x1D))
 131                                                   PressedKey = (PressedKeyCode - 0x04) + 'A';
 132                                                 else if ((PressedKeyCode >= 0x1E) && (PressedKeyCode <= 0x27))
 133                                                   PressedKey = (PressedKeyCode - 0x1E) + '0';
 134                                                 else if (PressedKeyCode == 0x2C)
 135                                                   PressedKey = ' ';
 136                                                 else if (PressedKeyCode == 0x28)
 137                                                   PressedKey = '\n';
 138
 139                                                 if (PressedKey)
 140                                                   putchar(PressedKey);
 141                                         }
 142                                 }
 143
 144                                 break;
 145                 }
 146
 147                 HID_Host_USBTask(&Keyboard_HID_Interface);
 148                 USB_USBTask();
 149         }
 150 }
 151
 152 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 153 void SetupHardware(void)
 154 {
 155         /* Disable watchdog if enabled by bootloader/fuses */
 156         MCUSR &= ~(1 << WDRF);
 157         wdt_disable();
 158
 159         /* Disable clock division */
 160         clock_prescale_set(clock_div_1);
 161
 162         /* Hardware Initialization */
 163         SerialStream_Init(9600, false);
 164         LEDs_Init();
 165         USB_Init();
 166 }
 167
 168 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 169  *  starts the library USB task to begin the enumeration and USB management process.
 170  */
 171 void EVENT_USB_Host_DeviceAttached(void)
 172 {
 173         puts_P(PSTR("Device Attached.\r\n"));
 174         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 175 }
 176
 177 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 178  *  stops the library USB task management process.
 179  */
 180 void EVENT_USB_Host_DeviceUnattached(void)
 181 {
 182         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 183         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 184 }
 185
 186 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 187  *  enumerated by the host and is now ready to be used by the application.
 188  */
 189 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 190 {
 191         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 192 }
 193
 194 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 195 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 196 {
 197         USB_ShutDown();
 198
 199         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 200                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 201
 202         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 203         for(;;);
 204 }
 205
 206 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 207  *  enumerating an attached USB device.
 208  */
 209 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 210 {
 211         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 212                                  " -- Error Code %d\r\n"
 213                                  " -- Sub Error Code %d\r\n"
 214                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 215
 216         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 217 }