Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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                                 LEDs_SetAllLEDs(LEDMASK_USB_READY);
 115                                 USB_HostState = HOST_STATE_Configured;
 116                                 break;
 117                         case HOST_STATE_Configured:
 118                                 if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))
 119                                 {
 120                                         USB_KeyboardReport_Data_t KeyboardReport;
 121                                         HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
 122
 123                                         LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 124
 125                                         uint8_t PressedKeyCode = KeyboardReport.KeyCode[0];
 126
 127                                         if (PressedKeyCode)
 128                                         {
 129                                                 char PressedKey = 0;
 130
 131                                                 LEDs_ToggleLEDs(LEDS_LED2);
 132
 133                                                 /* Retrieve pressed key character if alphanumeric */
 134                                                 if ((PressedKeyCode >= 0x04) && (PressedKeyCode <= 0x1D))
 135                                                   PressedKey = (PressedKeyCode - 0x04) + 'A';
 136                                                 else if ((PressedKeyCode >= 0x1E) && (PressedKeyCode <= 0x27))
 137                                                   PressedKey = (PressedKeyCode - 0x1E) + '0';
 138                                                 else if (PressedKeyCode == 0x2C)
 139                                                   PressedKey = ' ';
 140                                                 else if (PressedKeyCode == 0x28)
 141                                                   PressedKey = '\n';
 142
 143                                                 if (PressedKey)
 144                                                   putchar(PressedKey);
 145                                         }
 146                                 }
 147
 148                                 break;
 149                 }
 150
 151                 HID_Host_USBTask(&Keyboard_HID_Interface);
 152                 USB_USBTask();
 153         }
 154 }
 155
 156 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 157 void SetupHardware(void)
 158 {
 159         /* Disable watchdog if enabled by bootloader/fuses */
 160         MCUSR &= ~(1 << WDRF);
 161         wdt_disable();
 162
 163         /* Disable clock division */
 164         clock_prescale_set(clock_div_1);
 165
 166         /* Hardware Initialization */
 167         SerialStream_Init(9600, false);
 168         LEDs_Init();
 169         USB_Init();
 170 }
 171
 172 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 173  *  starts the library USB task to begin the enumeration and USB management process.
 174  */
 175 void EVENT_USB_Host_DeviceAttached(void)
 176 {
 177         puts_P(PSTR("Device Attached.\r\n"));
 178         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 179 }
 180
 181 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 182  *  stops the library USB task management process.
 183  */
 184 void EVENT_USB_Host_DeviceUnattached(void)
 185 {
 186         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 187         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 188 }
 189
 190 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 191  *  enumerated by the host and is now ready to be used by the application.
 192  */
 193 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 194 {
 195         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 196 }
 197
 198 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 199 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 200 {
 201         USB_ShutDown();
 202
 203         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 204                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 205
 206         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 207         for(;;);
 208 }
 209
 210 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 211  *  enumerating an attached USB device.
 212  */
 213 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 214 {
 215         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 216                                  " -- Error Code %d\r\n"
 217                                  " -- Sub Error Code %d\r\n"
 218                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 219
 220         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 221 }