Demos/Host/LowLevel/KeyboardHostWithParser/KeyboardHostWithParser.c

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