Demos/Host/LowLevel/KeyboardHost/KeyboardHost.c

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