Demos/Host/LowLevel/KeyboardHost/KeyboardHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_FG_CYAN "Keyboard HID Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         GlobalInterruptEnable();
  50
  51         for (;;)
  52         {
  53                 KeyboardHost_Task();
  54
  55                 USB_USBTask();
  56         }
  57 }
  58
  59 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  60 void SetupHardware(void)
  61 {
  62         /* Disable watchdog if enabled by bootloader/fuses */
  63         MCUSR &= ~(1 << WDRF);
  64         wdt_disable();
  65
  66         /* Disable clock division */
  67         clock_prescale_set(clock_div_1);
  68
  69         /* Hardware Initialization */
  70         Serial_Init(9600, false);
  71         LEDs_Init();
  72         USB_Init();
  73
  74         /* Create a stdio stream for the serial port for stdin and stdout */
  75         Serial_CreateStream(NULL);
  76 }
  77
  78 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  79  *  starts the library USB task to begin the enumeration and USB management process.
  80  */
  81 void EVENT_USB_Host_DeviceAttached(void)
  82 {
  83         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  84         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  85 }
  86
  87 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  88  *  stops the library USB task management process.
  89  */
  90 void EVENT_USB_Host_DeviceUnattached(void)
  91 {
  92         puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
  93         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  94 }
  95
  96 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  97  *  enumerated by the host and is now ready to be used by the application.
  98  */
  99 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 100 {
 101         puts_P(PSTR("Getting Config Data.\r\n"));
 102
 103         uint8_t ErrorCode;
 104
 105         /* Get and process the configuration descriptor data */
 106         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 107         {
 108                 if (ErrorCode == ControlError)
 109                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 110                 else
 111                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 112
 113                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 114
 115                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 116                 return;
 117         }
 118
 119         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 120         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 121         {
 122                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 123                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 124
 125                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 126                 return;
 127         }
 128
 129         /* HID class request to set the keyboard protocol to the Boot Protocol */
 130         USB_ControlRequest = (USB_Request_Header_t)
 131                 {
 132                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 133                         .bRequest      = HID_REQ_SetProtocol,
 134                         .wValue        = 0,
 135                         .wIndex        = 0,
 136                         .wLength       = 0,
 137                 };
 138
 139         /* Select the control pipe for the request transfer */
 140         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 141
 142         /* Send the request, display error and wait for device detach if request fails */
 143         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 144         {
 145                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Protocol).\r\n"
 146                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 147
 148                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 149                 USB_Host_SetDeviceConfiguration(0);
 150                 return;
 151         }
 152
 153         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 154         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 155 }
 156
 157 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 158 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 159 {
 160         USB_Disable();
 161
 162         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 163                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 164
 165         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 166         for(;;);
 167 }
 168
 169 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 170  *  enumerating an attached USB device.
 171  */
 172 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 173                                             const uint8_t SubErrorCode)
 174 {
 175         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 176                                  " -- Error Code %d\r\n"
 177                                  " -- Sub Error Code %d\r\n"
 178                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 179
 180         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 181 }
 182
 183 /** Task to read in and processes the next report from the attached device, displaying the report
 184  *  contents on the board LEDs and via the serial port.
 185  */
 186 void KeyboardHost_Task(void)
 187 {
 188         if (USB_HostState != HOST_STATE_Configured)
 189           return;
 190
 191         /* Select keyboard data pipe */
 192         Pipe_SelectPipe(KEYBOARD_DATA_IN_PIPE);
 193
 194         /* Unfreeze keyboard data pipe */
 195         Pipe_Unfreeze();
 196
 197         /* Check to see if a packet has been received */
 198         if (!(Pipe_IsINReceived()))
 199         {
 200                 /* Refreeze HID data IN pipe */
 201                 Pipe_Freeze();
 202
 203                 return;
 204         }
 205
 206         /* Ensure pipe contains data before trying to read from it */
 207         if (Pipe_IsReadWriteAllowed())
 208         {
 209                 USB_KeyboardReport_Data_t KeyboardReport;
 210
 211                 /* Read in keyboard report data */
 212                 Pipe_Read_Stream_LE(&KeyboardReport, sizeof(KeyboardReport), NULL);
 213
 214                 /* Indicate if the modifier byte is non-zero (special key such as shift is being pressed) */
 215                 LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 216
 217                 uint8_t KeyCode = KeyboardReport.KeyCode[0];
 218
 219                 /* Check if a key has been pressed */
 220                 if (KeyCode)
 221                 {
 222                         /* Toggle status LED to indicate keypress */
 223                         LEDs_ToggleLEDs(LEDS_LED2);
 224
 225                         char PressedKey = 0;
 226
 227                         /* Retrieve pressed key character if alphanumeric */
 228                         if ((KeyCode >= HID_KEYBOARD_SC_A) && (KeyCode <= HID_KEYBOARD_SC_Z))
 229                         {
 230                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_A) + 'A';
 231                         }
 232                         else if ((KeyCode >= HID_KEYBOARD_SC_1_AND_EXCLAMATION) &
 233                                          (KeyCode  < HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS))
 234                         {
 235                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_1_AND_EXCLAMATION) + '1';
 236                         }
 237                         else if (KeyCode == HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS)
 238                         {
 239                                 PressedKey = '0';
 240                         }
 241                         else if (KeyCode == HID_KEYBOARD_SC_SPACE)
 242                         {
 243                                 PressedKey = ' ';
 244                         }
 245                         else if (KeyCode == HID_KEYBOARD_SC_ENTER)
 246                         {
 247                                 PressedKey = '\n';
 248                         }
 249
 250                         /* Print the pressed key character out through the serial port if valid */
 251                         if (PressedKey)
 252                           putchar(PressedKey);
 253                 }
 254         }
 255
 256         /* Clear the IN endpoint, ready for next data packet */
 257         Pipe_ClearIN();
 258
 259         /* Refreeze keyboard data pipe */
 260         Pipe_Freeze();
 261 }
 262