Demos/Host/LowLevel/KeyboardHostWithParser/KeyboardHostWithParser.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 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 /** 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 Parser 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         Serial_Init(9600, false);
  70         LEDs_Init();
  71         USB_Init();
  72
  73         /* Create a stdio stream for the serial port for stdin and stdout */
  74         Serial_CreateStream(NULL);
  75 }
  76
  77 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  78  *  starts the library USB task to begin the enumeration and USB management process.
  79  */
  80 void EVENT_USB_Host_DeviceAttached(void)
  81 {
  82         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  83         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  84 }
  85
  86 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  87  *  stops the library USB task management process.
  88  */
  89 void EVENT_USB_Host_DeviceUnattached(void)
  90 {
  91         puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
  92         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  93 }
  94
  95 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  96  *  enumerated by the host and is now ready to be used by the application.
  97  */
  98 void EVENT_USB_Host_DeviceEnumerationComplete(void)
  99 {
 100         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 101 }
 102
 103 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 104 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 105 {
 106         USB_Disable();
 107
 108         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 109                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 110
 111         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 112         for(;;);
 113 }
 114
 115 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 116  *  enumerating an attached USB device.
 117  */
 118 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 119                                             const uint8_t SubErrorCode)
 120 {
 121         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 122                                  " -- Error Code %d\r\n"
 123                                  " -- Sub Error Code %d\r\n"
 124                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 125
 126         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 127 }
 128
 129 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 130  *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.
 131  */
 132 void Keyboard_HID_Task(void)
 133 {
 134         uint8_t ErrorCode;
 135
 136         switch (USB_HostState)
 137         {
 138                 case HOST_STATE_Addressed:
 139                         puts_P(PSTR("Getting Config Data.\r\n"));
 140
 141                         /* Get and process the configuration descriptor data */
 142                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 143                         {
 144                                 if (ErrorCode == ControlError)
 145                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 146                                 else
 147                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 148
 149                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 150
 151                                 /* Indicate error via status LEDs */
 152                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 153
 154                                 /* Wait until USB device disconnected */
 155                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 156                                 break;
 157                         }
 158
 159                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 160                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 161
 162                         {
 163                                 puts_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"));
 164                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 165
 166                                 /* Indicate error via status LEDs */
 167                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 168
 169                                 /* Wait until USB device disconnected */
 170                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 171                                 break;
 172                         }
 173
 174                         printf_P(PSTR("Processing HID Report (Size %d Bytes).\r\n"), HIDReportSize);
 175
 176                         /* Get and process the device's first HID report descriptor */
 177                         if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)
 178                         {
 179                                 puts_P(PSTR(ESC_FG_RED "Report Parse Error.\r\n"));
 180
 181                                 if (!(HIDReportInfo.TotalReportItems))
 182                                         puts_P(PSTR("Not a valid Keyboard." ESC_FG_WHITE));
 183                                 else
 184                                         printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 185
 186                                 /* Indicate error via status LEDs */
 187                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 188
 189                                 /* Wait until USB device disconnected */
 190                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 191                                 break;
 192                         }
 193
 194                         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 195
 196                         USB_HostState = HOST_STATE_Configured;
 197                         break;
 198                 case HOST_STATE_Configured:
 199                         /* Select and unfreeze keyboard data pipe */
 200                         Pipe_SelectPipe(KEYBOARD_DATA_IN_PIPE);
 201                         Pipe_Unfreeze();
 202
 203                         /* Check to see if a packet has been received */
 204                         if (Pipe_IsINReceived())
 205                         {
 206                                 /* Check if data has been received from the attached keyboard */
 207                                 if (Pipe_IsReadWriteAllowed())
 208                                 {
 209                                         /* Create buffer big enough for the report */
 210                                         uint8_t KeyboardReport[Pipe_BytesInPipe()];
 211
 212                                         /* Load in the keyboard report */
 213                                         Pipe_Read_Stream_LE(KeyboardReport, Pipe_BytesInPipe(), NULL);
 214
 215                                         /* Process the read in keyboard report from the device */
 216                                         ProcessKeyboardReport(KeyboardReport);
 217                                 }
 218
 219                                 /* Clear the IN endpoint, ready for next data packet */
 220                                 Pipe_ClearIN();
 221                         }
 222
 223                         /* Freeze keyboard data pipe */
 224                         Pipe_Freeze();
 225                         break;
 226         }
 227 }
 228
 229 /** Processes a read HID report from an attached keyboard, extracting out elements via the HID parser results
 230  *  as required and prints pressed characters to the serial port. Each time a key is typed, a board LED is toggled.
 231  *
 232  *  \param[in] KeyboardReport  Pointer to a HID report from an attached keyboard device
 233  */
 234 void ProcessKeyboardReport(uint8_t* KeyboardReport)
 235 {
 236         /* Check each HID report item in turn, looking for keyboard scan code reports */
 237         for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 238         {
 239                 /* Create a temporary item pointer to the next report item */
 240                 HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 241
 242                 /* Check if the current report item is a keyboard scan-code */
 243                 if ((ReportItem->Attributes.Usage.Page      == USAGE_PAGE_KEYBOARD) &&
 244                         (ReportItem->Attributes.BitSize         == 8)                   &&
 245                         (ReportItem->Attributes.Logical.Maximum > 1)                    &&
 246                         (ReportItem->ItemType                   == HID_REPORT_ITEM_In))
 247                 {
 248                         /* Retrieve the keyboard scan-code from the report data retrieved from the device */
 249                         bool FoundData = USB_GetHIDReportItemInfo(KeyboardReport, ReportItem);
 250
 251                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 252                         if (!(FoundData))
 253                           continue;
 254
 255                         /* Key code is an unsigned char in length, cast to the appropriate type */
 256                         uint8_t KeyCode = (uint8_t)ReportItem->Value;
 257
 258                         /* If scan-code is non-zero, a key is being pressed */
 259                         if (KeyCode)
 260                         {
 261                                 /* Toggle status LED to indicate keypress */
 262                                 LEDs_ToggleLEDs(LEDS_LED2);
 263
 264                                 char PressedKey = 0;
 265
 266                                 /* Retrieve pressed key character if alphanumeric */
 267                                 if ((KeyCode >= HID_KEYBOARD_SC_A) && (KeyCode <= HID_KEYBOARD_SC_Z))
 268                                 {
 269                                         PressedKey = (KeyCode - HID_KEYBOARD_SC_A) + 'A';
 270                                 }
 271                                 else if ((KeyCode >= HID_KEYBOARD_SC_1_AND_EXCLAMATION) &
 272                                                  (KeyCode  < HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS))
 273                                 {
 274                                         PressedKey = (KeyCode - HID_KEYBOARD_SC_1_AND_EXCLAMATION) + '1';
 275                                 }
 276                                 else if (KeyCode == HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS)
 277                                 {
 278                                         PressedKey = '0';
 279                                 }
 280                                 else if (KeyCode == HID_KEYBOARD_SC_SPACE)
 281                                 {
 282                                         PressedKey = ' ';
 283                                 }
 284                                 else if (KeyCode == HID_KEYBOARD_SC_ENTER)
 285                                 {
 286                                         PressedKey = '\n';
 287                                 }
 288
 289                                 /* Print the pressed key character out through the serial port if valid */
 290                                 if (PressedKey)
 291                                   putchar(PressedKey);
 292                         }
 293
 294                         /* Once a scan-code is found, stop scanning through the report items */
 295                         break;
 296                 }
 297         }
 298 }
 299