Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2020.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2020  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 /** Processed HID report descriptor items structure, containing information on each HID report element */
  40 static HID_ReportInfo_t HIDReportInfo;
  41
  42 /** LUFA HID Class driver interface configuration and state information. This structure is
  43  *  passed to all HID Class driver functions, so that multiple instances of the same class
  44  *  within a device can be differentiated from one another.
  45  */
  46 USB_ClassInfo_HID_Host_t Keyboard_HID_Interface =
  47         {
  48                 .Config =
  49                         {
  50                                 .DataINPipe             =
  51                                         {
  52                                                 .Address        = (PIPE_DIR_IN  | 1),
  53                                                 .Banks          = 1,
  54                                         },
  55                                 .DataOUTPipe            =
  56                                         {
  57                                                 .Address        = (PIPE_DIR_OUT | 2),
  58                                                 .Banks          = 1,
  59                                         },
  60                                 .HIDInterfaceProtocol   = HID_CSCP_NonBootProtocol,
  61                                 .HIDParserData          = &HIDReportInfo
  62                         },
  63         };
  64
  65
  66 /** Main program entry point. This routine configures the hardware required by the application, then
  67  *  enters a loop to run the application tasks in sequence.
  68  */
  69 int main(void)
  70 {
  71         SetupHardware();
  72
  73         puts_P(PSTR(ESC_FG_CYAN "Keyboard Host Demo running.\r\n" ESC_FG_WHITE));
  74
  75         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  76         GlobalInterruptEnable();
  77
  78         for (;;)
  79         {
  80                 KeyboardHost_Task();
  81
  82                 HID_Host_USBTask(&Keyboard_HID_Interface);
  83                 USB_USBTask();
  84         }
  85 }
  86
  87 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  88 void SetupHardware(void)
  89 {
  90 #if (ARCH == ARCH_AVR8)
  91         /* Disable watchdog if enabled by bootloader/fuses */
  92         MCUSR &= ~(1 << WDRF);
  93         wdt_disable();
  94
  95         /* Disable clock division */
  96         clock_prescale_set(clock_div_1);
  97 #endif
  98
  99         /* Hardware Initialization */
 100         Serial_Init(9600, false);
 101         LEDs_Init();
 102         USB_Init();
 103
 104         /* Create a stdio stream for the serial port for stdin and stdout */
 105         Serial_CreateStream(NULL);
 106 }
 107
 108 /** Task to manage an enumerated USB keyboard once connected, to display key state
 109  *  data as it is received.
 110  */
 111 void KeyboardHost_Task(void)
 112 {
 113         if (USB_HostState != HOST_STATE_Configured)
 114           return;
 115
 116         if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))
 117         {
 118                 uint8_t KeyboardReport[Keyboard_HID_Interface.State.LargestReportSize];
 119                 HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
 120
 121                 for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 122                 {
 123                         HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 124
 125                         /* Update the report item value if it is contained within the current report */
 126                         if (!(USB_GetHIDReportItemInfo(KeyboardReport, ReportItem)))
 127                           continue;
 128
 129                         /* Determine what report item is being tested, process updated value as needed */
 130                         if ((ReportItem->Attributes.Usage.Page      == USAGE_PAGE_KEYBOARD) &&
 131                                 (ReportItem->Attributes.BitSize         == 8)                   &&
 132                                 (ReportItem->Attributes.Logical.Maximum > 1)                    &&
 133                                 (ReportItem->ItemType                   == HID_REPORT_ITEM_In))
 134                         {
 135                                 /* Key code is an unsigned char in length, cast to the appropriate type */
 136                                 uint8_t KeyCode = (uint8_t)ReportItem->Value;
 137
 138                                 /* If scan-code is non-zero, a key is being pressed */
 139                                 if (KeyCode)
 140                                 {
 141                                         /* Toggle status LED to indicate keypress */
 142                                         LEDs_ToggleLEDs(LEDS_LED2);
 143
 144                                         char PressedKey = 0;
 145
 146                                         /* Convert scan-code to printable character if alphanumeric */
 147                                         if ((KeyCode >= HID_KEYBOARD_SC_A) && (KeyCode <= HID_KEYBOARD_SC_Z))
 148                                         {
 149                                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_A) + 'A';
 150                                         }
 151                                         else if ((KeyCode >= HID_KEYBOARD_SC_1_AND_EXCLAMATION) &
 152                                                          (KeyCode  < HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS))
 153                                         {
 154                                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_1_AND_EXCLAMATION) + '1';
 155                                         }
 156                                         else if (KeyCode == HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS)
 157                                         {
 158                                                 PressedKey = '0';
 159                                         }
 160                                         else if (KeyCode == HID_KEYBOARD_SC_SPACE)
 161                                         {
 162                                                 PressedKey = ' ';
 163                                         }
 164                                         else if (KeyCode == HID_KEYBOARD_SC_ENTER)
 165                                         {
 166                                                 PressedKey = '\n';
 167                                         }
 168
 169                                         /* Print the pressed key character out through the serial port if valid */
 170                                         if (PressedKey)
 171                                           putchar(PressedKey);
 172                                 }
 173
 174                                 /* Once a scan-code is found, stop scanning through the report items */
 175                                 break;
 176                         }
 177                 }
 178         }
 179 }
 180
 181 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 182  *  starts the library USB task to begin the enumeration and USB management process.
 183  */
 184 void EVENT_USB_Host_DeviceAttached(void)
 185 {
 186         puts_P(PSTR("Device Attached.\r\n"));
 187         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 188 }
 189
 190 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 191  *  stops the library USB task management process.
 192  */
 193 void EVENT_USB_Host_DeviceUnattached(void)
 194 {
 195         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 196         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 197 }
 198
 199 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 200  *  enumerated by the host and is now ready to be used by the application.
 201  */
 202 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 203 {
 204         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 205
 206         uint16_t ConfigDescriptorSize;
 207         uint8_t  ConfigDescriptorData[512];
 208
 209         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 210                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 211         {
 212                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 213                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 214                 return;
 215         }
 216
 217         if (HID_Host_ConfigurePipes(&Keyboard_HID_Interface,
 218                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 219         {
 220                 puts_P(PSTR("Attached Device Not a Valid Keyboard.\r\n"));
 221                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 222                 return;
 223         }
 224
 225         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 226         {
 227                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 228                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 229                 return;
 230         }
 231
 232         if (HID_Host_SetReportProtocol(&Keyboard_HID_Interface) != 0)
 233         {
 234                 puts_P(PSTR("Error Setting Report Protocol Mode or Not a Valid Keyboard.\r\n"));
 235                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 236                 USB_Host_SetDeviceConfiguration(0);
 237                 return;
 238         }
 239
 240         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 241         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 242 }
 243
 244 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 245 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 246 {
 247         USB_Disable();
 248
 249         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 250                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 251
 252         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 253         for(;;);
 254 }
 255
 256 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 257  *  enumerating an attached USB device.
 258  */
 259 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 260                                             const uint8_t SubErrorCode)
 261 {
 262         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 263                                  " -- Error Code %d\r\n"
 264                                  " -- Sub Error Code %d\r\n"
 265                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 266
 267         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 268 }
 269
 270 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 271  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 272  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 273  *  have occupied).
 274  *
 275  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
 276  *
 277  *  \return Boolean \c true if the item should be stored into the HID report structure, \c false if it should be discarded
 278  */
 279 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
 280 {
 281         /* Check the attributes of the current item - see if we are interested in it or not;
 282          * only store KEYBOARD usage page items into the Processed HID Report structure to
 283          * save RAM and ignore the rest
 284          */
 285         return (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_KEYBOARD);
 286 }
 287