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