Demos/Host/LowLevel/KeyboardHostWithParser/KeyboardHostWithParser.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 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         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 "\r\nDevice 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 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 127  *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.
 128  */
 129 void Keyboard_HID_Task(void)
 130 {
 131         uint8_t ErrorCode;
 132
 133         switch (USB_HostState)
 134         {
 135                 case HOST_STATE_Addressed:
 136                         puts_P(PSTR("Getting Config Data.\r\n"));
 137
 138                         /* Get and process the configuration descriptor data */
 139                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 140                         {
 141                                 if (ErrorCode == ControlError)
 142                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 143                                 else
 144                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 145
 146                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 147
 148                                 /* Indicate error via status LEDs */
 149                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 150
 151                                 /* Wait until USB device disconnected */
 152                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 153                                 break;
 154                         }
 155
 156                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 157                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 158
 159                         {
 160                                 puts_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"));
 161                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 162
 163                                 /* Indicate error via status LEDs */
 164                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 165
 166                                 /* Wait until USB device disconnected */
 167                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 168                                 break;
 169                         }
 170
 171                         printf_P(PSTR("Processing HID Report (Size %d Bytes).\r\n"), HIDReportSize);
 172
 173                         /* Get and process the device's first HID report descriptor */
 174                         if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)
 175                         {
 176                                 puts_P(PSTR(ESC_FG_RED "Report Parse Error.\r\n"));
 177
 178                                 if (!(HIDReportInfo.TotalReportItems))
 179                                         puts_P(PSTR("Not a valid Keyboard." ESC_FG_WHITE));
 180                                 else
 181                                         printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 182
 183                                 /* Indicate error via status LEDs */
 184                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 185
 186                                 /* Wait until USB device disconnected */
 187                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 188                                 break;
 189                         }
 190
 191                         printf("Total Reports: %d\r\n", HIDReportInfo.TotalDeviceReports);
 192
 193                         for (uint8_t i = 0; i < HIDReportInfo.TotalDeviceReports; i++)
 194                         {
 195                                 HID_ReportSizeInfo_t* CurrReportIDInfo = &HIDReportInfo.ReportIDSizes[i];
 196
 197                                 uint8_t ReportSizeInBits      = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_In];
 198                                 uint8_t ReportSizeOutBits     = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Out];
 199                                 uint8_t ReportSizeFeatureBits = CurrReportIDInfo->ReportSizeBits[HID_REPORT_ITEM_Feature];
 200
 201                                 /* Print out the byte sizes of each report within the device */
 202                                 printf_P(PSTR("  + Report ID %d - In: %d bytes, Out: %d bytes, Feature: %d bytes\r\n"),
 203                                          CurrReportIDInfo->ReportID,
 204                                          ((ReportSizeInBits      >> 3) + ((ReportSizeInBits      & 0x07) != 0)),
 205                                          ((ReportSizeOutBits     >> 3) + ((ReportSizeOutBits     & 0x07) != 0)),
 206                                          ((ReportSizeFeatureBits >> 3) + ((ReportSizeFeatureBits & 0x07) != 0)));
 207                         }
 208
 209                         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 210
 211                         USB_HostState = HOST_STATE_Configured;
 212                         break;
 213                 case HOST_STATE_Configured:
 214                         /* Select and unfreeze keyboard data pipe */
 215                         Pipe_SelectPipe(KEYBOARD_DATA_IN_PIPE);
 216                         Pipe_Unfreeze();
 217
 218                         /* Check to see if a packet has been received */
 219                         if (Pipe_IsINReceived())
 220                         {
 221                                 /* Check if data has been received from the attached keyboard */
 222                                 if (Pipe_IsReadWriteAllowed())
 223                                 {
 224                                         /* Create buffer big enough for the report */
 225                                         uint8_t KeyboardReport[Pipe_BytesInPipe()];
 226
 227                                         /* Load in the keyboard report */
 228                                         Pipe_Read_Stream_LE(KeyboardReport, Pipe_BytesInPipe());
 229
 230                                         /* Process the read in keyboard report from the device */
 231                                         ProcessKeyboardReport(KeyboardReport);
 232                                 }
 233
 234                                 /* Clear the IN endpoint, ready for next data packet */
 235                                 Pipe_ClearIN();
 236                         }
 237
 238                         /* Freeze keyboard data pipe */
 239                         Pipe_Freeze();
 240                         break;
 241         }
 242 }
 243
 244 /** Processes a read HID report from an attached keyboard, extracting out elements via the HID parser results
 245  *  as required and prints pressed characters to the serial port. Each time a key is typed, a board LED is toggled.
 246  *
 247  *  \param[in] KeyboardReport  Pointer to a HID report from an attached keyboard device
 248  */
 249 void ProcessKeyboardReport(uint8_t* KeyboardReport)
 250 {
 251         /* Check each HID report item in turn, looking for keyboard scan code reports */
 252         for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 253         {
 254                 /* Create a temporary item pointer to the next report item */
 255                 HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 256
 257                 /* Check if the current report item is a keyboard scan-code */
 258                 if ((ReportItem->Attributes.Usage.Page      == USAGE_PAGE_KEYBOARD) &&
 259                         (ReportItem->Attributes.BitSize         == 8)                   &&
 260                         (ReportItem->Attributes.Logical.Maximum > 1)                    &&
 261                         (ReportItem->ItemType                   == HID_REPORT_ITEM_In))
 262                 {
 263                         /* Retrieve the keyboard scan-code from the report data retrieved from the device */
 264                         bool FoundData = USB_GetHIDReportItemInfo(KeyboardReport, ReportItem);
 265
 266                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 267                         if (!(FoundData))
 268                           continue;
 269
 270                         /* Key code is an unsigned char in length, cast to the appropriate type */
 271                         uint8_t KeyCode = (uint8_t)ReportItem->Value;
 272
 273                         /* If scan-code is non-zero, a key is being pressed */
 274                         if (KeyCode)
 275                         {
 276                                 /* Toggle status LED to indicate keypress */
 277                                 LEDs_ToggleLEDs(LEDS_LED2);
 278
 279                                 char PressedKey = 0;
 280
 281                                 /* Retrieve pressed key character if alphanumeric */
 282                                 if ((KeyCode >= HID_KEYBOARD_SC_A) && (KeyCode <= HID_KEYBOARD_SC_Z))
 283                                 {
 284                                         PressedKey = (KeyCode - HID_KEYBOARD_SC_A) + 'A';
 285                                 }
 286                                 else if ((KeyCode >= HID_KEYBOARD_SC_1_AND_EXCLAMATION) &
 287                                                  (KeyCode <= HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS))
 288                                 {
 289                                         PressedKey = (KeyCode - HID_KEYBOARD_SC_1_AND_EXCLAMATION) + '0';
 290                                 }
 291                                 else if (KeyCode == HID_KEYBOARD_SC_SPACE)
 292                                 {
 293                                         PressedKey = ' ';
 294                                 }
 295                                 else if (KeyCode == HID_KEYBOARD_SC_ENTER)
 296                                 {
 297                                         PressedKey = '\n';
 298                                 }
 299
 300                                 /* Print the pressed key character out through the serial port if valid */
 301                                 if (PressedKey)
 302                                   putchar(PressedKey);
 303                         }
 304
 305                         /* Once a scan-code is found, stop scanning through the report items */
 306                         break;
 307                 }
 308         }
 309 }
 310