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