Demos/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 /* Project Tags, for reading out using the ButtLoad project */
  40 BUTTLOADTAG(ProjName,    "LUFA KBD Host App");
  41 BUTTLOADTAG(BuildTime,   __TIME__);
  42 BUTTLOADTAG(BuildDate,   __DATE__);
  43 BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);
  44
  45 /* Scheduler Task List */
  46 TASK_LIST
  47 {
  48         { Task: USB_USBTask          , TaskStatus: TASK_STOP },
  49         { Task: USB_Keyboard_Host    , TaskStatus: TASK_STOP },
  50 };
  51
  52
  53 /** Main program entry point. This routine configures the hardware required by the application, then
  54  *  starts the scheduler to run the application tasks.
  55  */
  56 int main(void)
  57 {
  58         /* Disable watchdog if enabled by bootloader/fuses */
  59         MCUSR &= ~(1 << WDRF);
  60         wdt_disable();
  61
  62         /* Disable Clock Division */
  63         SetSystemClockPrescaler(0);
  64
  65         /* Hardware Initialization */
  66         SerialStream_Init(9600, false);
  67         LEDs_Init();
  68
  69         /* Indicate USB not ready */
  70         UpdateStatus(Status_USBNotReady);
  71
  72         /* Initialize Scheduler so that it can be used */
  73         Scheduler_Init();
  74
  75         /* Initialize USB Subsystem */
  76         USB_Init();
  77
  78         /* Startup message */
  79         puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
  80                "Keyboard Host Demo running.\r\n" ESC_INVERSE_OFF));
  81
  82         /* Scheduling - routine never returns, so put this last in the main function */
  83         Scheduler_Start();
  84 }
  85
  86 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  87  *  starts the library USB task to begin the enumeration and USB management process.
  88  */
  89 EVENT_HANDLER(USB_DeviceAttached)
  90 {
  91         puts_P(PSTR("Device Attached.\r\n"));
  92         UpdateStatus(Status_USBEnumerating);
  93
  94         /* Start USB management task to enumerate the device */
  95         Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
  96 }
  97
  98 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  99  *  stops the library USB task management process.
 100  */
 101 EVENT_HANDLER(USB_DeviceUnattached)
 102 {
 103         /* Stop Keyboard and USB management task */
 104         Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
 105         Scheduler_SetTaskMode(USB_Keyboard_Host, TASK_STOP);
 106
 107         puts_P(PSTR("Device Unattached.\r\n"));
 108         UpdateStatus(Status_USBNotReady);
 109 }
 110
 111 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 112  *  enumerated by the host and is now ready to be used by the application.
 113  */
 114 EVENT_HANDLER(USB_DeviceEnumerationComplete)
 115 {
 116         /* Start Keyboard Host task */
 117         Scheduler_SetTaskMode(USB_Keyboard_Host, TASK_RUN);
 118
 119         /* Indicate device enumeration complete */
 120         UpdateStatus(Status_USBReady);
 121 }
 122
 123 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 124 EVENT_HANDLER(USB_HostError)
 125 {
 126         USB_ShutDown();
 127
 128         puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
 129         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 130
 131         UpdateStatus(Status_HardwareError);
 132         for(;;);
 133 }
 134
 135 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
 136  *  enumerating an attached USB device.
 137  */
 138 EVENT_HANDLER(USB_DeviceEnumerationFailed)
 139 {
 140         puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
 141         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 142         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 143         printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);
 144
 145         UpdateStatus(Status_EnumerationError);
 146 }
 147
 148 /** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
 149  *  log to a serial port, or anything else that is suitable for status updates.
 150  *
 151  *  \param CurrentStatus  Current status of the system, from the KeyboardHost_StatusCodes_t enum
 152  */
 153 void UpdateStatus(uint8_t CurrentStatus)
 154 {
 155         uint8_t LEDMask = LEDS_NO_LEDS;
 156
 157         /* Set the LED mask to the appropriate LED mask based on the given status code */
 158         switch (CurrentStatus)
 159         {
 160                 case Status_USBNotReady:
 161                         LEDMask = (LEDS_LED1);
 162                         break;
 163                 case Status_USBEnumerating:
 164                         LEDMask = (LEDS_LED1 | LEDS_LED2);
 165                         break;
 166                 case Status_USBReady:
 167                         LEDMask = (LEDS_LED2);
 168                         break;
 169                 case Status_EnumerationError:
 170                 case Status_HardwareError:
 171                         LEDMask = (LEDS_LED1 | LEDS_LED3);
 172                         break;
 173         }
 174
 175         /* Set the board LEDs to the new LED mask */
 176         LEDs_SetAllLEDs(LEDMask);
 177 }
 178
 179 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 180  *  HID reports from the device and display the results onto the board LEDs.
 181  */
 182 TASK(USB_Keyboard_Host)
 183 {
 184         uint8_t ErrorCode;
 185
 186         switch (USB_HostState)
 187         {
 188                 case HOST_STATE_Addressed:
 189                         /* Standard request to set the device configuration to configuration 1 */
 190                         USB_HostRequest = (USB_Host_Request_Header_t)
 191                                 {
 192                                         bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 193                                         bRequest:      REQ_SetConfiguration,
 194                                         wValue:        1,
 195                                         wIndex:        0,
 196                                         wLength:       0,
 197                                 };
 198
 199                         /* Send the request, display error and wait for device detatch if request fails */
 200                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 201                         {
 202                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 203                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 204
 205                                 /* Indicate error status */
 206                                 UpdateStatus(Status_EnumerationError);
 207
 208                                 /* Wait until USB device disconnected */
 209                                 while (USB_IsConnected);
 210                                 break;
 211                         }
 212
 213                         USB_HostState = HOST_STATE_Configured;
 214                         break;
 215                 case HOST_STATE_Configured:
 216                         puts_P(PSTR("Getting Config Data.\r\n"));
 217
 218                         /* Get and process the configuration descriptor data */
 219                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 220                         {
 221                                 if (ErrorCode == ControlError)
 222                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 223                                 else
 224                                   puts_P(PSTR("Invalid Device.\r\n"));
 225
 226                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 227
 228                                 /* Indicate error status */
 229                                 UpdateStatus(Status_EnumerationError);
 230
 231                                 /* Wait until USB device disconnected */
 232                                 while (USB_IsConnected);
 233                                 break;
 234                         }
 235
 236                         /* HID class request to set the keyboard protocol to the Boot Protocol */
 237                         USB_HostRequest = (USB_Host_Request_Header_t)
 238                                 {
 239                                         bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 240                                         bRequest:      REQ_SetProtocol,
 241                                         wValue:        0,
 242                                         wIndex:        0,
 243                                         wLength:       0,
 244                                 };
 245
 246                         /* Send the request, display error and wait for device detatch if request fails */
 247                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 248                         {
 249                                 puts_P(PSTR("Control Error (Set Protocol).\r\n"));
 250                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 251
 252                                 /* Indicate error status */
 253                                 UpdateStatus(Status_EnumerationError);
 254
 255                                 /* Wait until USB device disconnected */
 256                                 while (USB_IsConnected);
 257                                 break;
 258                         }
 259
 260                         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 261
 262                         USB_HostState = HOST_STATE_Ready;
 263                         break;
 264                 case HOST_STATE_Ready:
 265                         /* Select and unfreeze keyboard data pipe */
 266                         Pipe_SelectPipe(KEYBOARD_DATAPIPE);
 267                         Pipe_Unfreeze();
 268
 269                         /* Check if data has been received from the attached keyboard */
 270                         if (Pipe_ReadWriteAllowed())
 271                         {
 272                                 USB_KeyboardReport_Data_t KeyboardReport;
 273
 274                                 /* Read in keyboard report data */
 275                                 Pipe_Read_Stream_LE(&KeyboardReport, sizeof(KeyboardReport));
 276
 277                                 /* Clear the IN endpoint, ready for next data packet */
 278                                 Pipe_ClearCurrentBank();
 279
 280                                 /* Indicate if the modifier byte is non-zero */
 281                                 LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 282
 283                                 /* Check if a key has been pressed */
 284                                 if (KeyboardReport.KeyCode)
 285                                 {
 286                                         /* Toggle status LED to indicate keypress */
 287                                         if (LEDs_GetLEDs() & LEDS_LED2)
 288                                           LEDs_TurnOffLEDs(LEDS_LED2);
 289                                         else
 290                                           LEDs_TurnOnLEDs(LEDS_LED2);
 291
 292                                         char PressedKey = 0;
 293
 294                                         /* Retrieve pressed key character if alphanumeric */
 295                                         if ((KeyboardReport.KeyCode >= 0x04) && (KeyboardReport.KeyCode <= 0x1D))
 296                                           PressedKey = (KeyboardReport.KeyCode - 0x04) + 'A';
 297                                         else if ((KeyboardReport.KeyCode >= 0x1E) && (KeyboardReport.KeyCode <= 0x27))
 298                                           PressedKey = (KeyboardReport.KeyCode - 0x1E) + '0';
 299                                         else if (KeyboardReport.KeyCode == 0x2C)
 300                                           PressedKey = ' ';
 301                                         else if (KeyboardReport.KeyCode == 0x28)
 302                                           PressedKey = '\n';
 303
 304                                         /* Print the pressed key character out through the serial port if valid */
 305                                         if (PressedKey)
 306                                           putchar(PressedKey);
 307                                 }
 308                         }
 309
 310                         /* Freeze keyboard data pipe */
 311                         Pipe_Freeze();
 312                         break;
 313         }
 314 }