Demos/Host/KeyboardHostWithParser/KeyboardHostWithParser.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 KeyboardHostWithParser demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "KeyboardHostWithParser.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         clock_prescale_set(clock_div_1);
  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         /* Start-up 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("\r\nDevice 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 occurred 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 KeyboardHostWithParser_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                 case Status_Busy:
 174                         LEDMask = (LEDS_LED1 | LEDS_LED4);
 175                         break;
 176         }
 177
 178         /* Set the board LEDs to the new LED mask */
 179         LEDs_SetAllLEDs(LEDMask);
 180 }
 181
 182 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 183  *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.
 184  */
 185 TASK(USB_Keyboard_Host)
 186 {
 187         uint8_t ErrorCode;
 188
 189         switch (USB_HostState)
 190         {
 191                 case HOST_STATE_Addressed:
 192                         /* Standard request to set the device configuration to configuration 1 */
 193                         USB_HostRequest = (USB_Host_Request_Header_t)
 194                                 {
 195                                         bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 196                                         bRequest:      REQ_SetConfiguration,
 197                                         wValue:        1,
 198                                         wIndex:        0,
 199                                         wLength:       0,
 200                                 };
 201
 202                         /* Select the control pipe for the request transfer */
 203                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 204
 205                         /* Send the request, display error and wait for device detach if request fails */
 206                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 207                         {
 208                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 209                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 210
 211                                 /* Indicate error via status LEDs */
 212                                 UpdateStatus(Status_EnumerationError);
 213
 214                                 /* Wait until USB device disconnected */
 215                                 while (USB_IsConnected);
 216                                 break;
 217                         }
 218
 219                         USB_HostState = HOST_STATE_Configured;
 220                         break;
 221                 case HOST_STATE_Configured:
 222                         puts_P(PSTR("Getting Config Data.\r\n"));
 223
 224                         /* Get and process the configuration descriptor data */
 225                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 226                         {
 227                                 if (ErrorCode == ControlError)
 228                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 229                                 else
 230                                   puts_P(PSTR("Invalid Device.\r\n"));
 231
 232                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 233
 234                                 /* Indicate error via status LEDs */
 235                                 UpdateStatus(Status_EnumerationError);
 236
 237                                 /* Wait until USB device disconnected */
 238                                 while (USB_IsConnected);
 239                                 break;
 240                         }
 241
 242                         puts_P(PSTR("Processing HID Report.\r\n"));
 243
 244                         /* LEDs one and two on to indicate busy processing */
 245                         UpdateStatus(Status_Busy);
 246
 247                         /* Get and process the device's first HID report descriptor */
 248                         if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)
 249                         {
 250                                 puts_P(PSTR("Report Parse Error.\r\n"));
 251                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 252
 253                                 /* Indicate error via status LEDs */
 254                                 UpdateStatus(Status_EnumerationError);
 255
 256                                 /* Wait until USB device disconnected */
 257                                 while (USB_IsConnected);
 258                                 break;
 259                         }
 260
 261                         /* All LEDs off - ready to indicate key presses */
 262                         UpdateStatus(Status_USBReady);
 263
 264                         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 265
 266                         USB_HostState = HOST_STATE_Ready;
 267                         break;
 268                 case HOST_STATE_Ready:
 269                         /* Select and unfreeze keyboard data pipe */
 270                         Pipe_SelectPipe(KEYBOARD_DATAPIPE);
 271                         Pipe_Unfreeze();
 272
 273                         /* Check if data has been received from the attached keyboard */
 274                         if (Pipe_ReadWriteAllowed())
 275                         {
 276                                 /* Create buffer big enough for the report */
 277                                 uint8_t KeyboardReport[Pipe_BytesInPipe()];
 278
 279                                 /* Load in the keyboard report */
 280                                 Pipe_Read_Stream_LE(KeyboardReport, Pipe_BytesInPipe());
 281
 282                                 /* Clear the IN endpoint, ready for next data packet */
 283                                 Pipe_ClearCurrentBank();
 284
 285                                 /* Check each HID report item in turn, looking for keyboard scan code reports */
 286                                 for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 287                                 {
 288                                         /* Create a temporary item pointer to the next report item */
 289                                         HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 290
 291                                         /* Check if the current report item is a keyboard scancode */
 292                                         if ((ReportItem->Attributes.Usage.Page      == USAGE_PAGE_KEYBOARD) &&
 293                                             (ReportItem->Attributes.BitSize         == 8)                   &&
 294                                             (ReportItem->Attributes.Logical.Maximum > 1)                    &&
 295                                             (ReportItem->ItemType                   == REPORT_ITEM_TYPE_In))
 296                                         {
 297                                                 /* Retrieve the keyboard scancode from the report data retrieved from the device */
 298                                                 bool FoundData = GetReportItemInfo(KeyboardReport, ReportItem);
 299
 300                                                 /* For multi-report devices - if the requested data was not in the issued report, continue */
 301                                                 if (!(FoundData))
 302                                                   continue;
 303
 304                                                 /* Key code is an unsigned char in length, cast to the appropriate type */
 305                                                 uint8_t KeyCode = (uint8_t)ReportItem->Value;
 306
 307                                                 /* If scancode is non-zero, a key is being pressed */
 308                                                 if (KeyCode)
 309                                                 {
 310                                                         /* Toggle status LED to indicate keypress */
 311                                                         if (LEDs_GetLEDs() & LEDS_LED2)
 312                                                           LEDs_TurnOffLEDs(LEDS_LED2);
 313                                                         else
 314                                                           LEDs_TurnOnLEDs(LEDS_LED2);
 315
 316                                                         char PressedKey = 0;
 317
 318                                                         /* Convert scancode to printable character if alphanumeric */
 319                                                         if ((KeyCode >= 0x04) && (KeyCode <= 0x1D))
 320                                                           PressedKey = (KeyCode - 0x04) + 'A';
 321                                                         else if ((KeyCode >= 0x1E) && (KeyCode <= 0x27))
 322                                                           PressedKey = (KeyCode - 0x1E) + '0';
 323                                                         else if (KeyCode == 0x2C)
 324                                                           PressedKey = ' ';
 325                                                         else if (KeyCode == 0x28)
 326                                                           PressedKey = '\n';
 327
 328                                                         /* Print the pressed key character out through the serial port if valid */
 329                                                         if (PressedKey)
 330                                                           putchar(PressedKey);
 331                                                 }
 332
 333                                                 /* Once a scancode is found, stop scanning through the report items */
 334                                                 break;
 335                                         }
 336                                 }
 337                         }
 338
 339                         /* Freeze keyboard data pipe */
 340                         Pipe_Freeze();
 341                         break;
 342         }
 343 }