Demos/Host/ClassDriver/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 /** 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         /* Disable watchdog if enabled by bootloader/fuses */
  91         MCUSR &= ~(1 << WDRF);
  92         wdt_disable();
  93
  94         /* Disable clock division */
  95         clock_prescale_set(clock_div_1);
  96
  97         /* Hardware Initialization */
  98         Serial_Init(9600, false);
  99         LEDs_Init();
 100         USB_Init();
 101
 102         /* Create a stdio stream for the serial port for stdin and stdout */
 103         Serial_CreateStream(NULL);
 104 }
 105
 106 /** Task to manage an enumerated USB keyboard once connected, to display key state
 107  *  data as it is received.
 108  */
 109 void KeyboardHost_Task(void)
 110 {
 111         if (USB_HostState != HOST_STATE_Configured)
 112           return;
 113
 114         if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))
 115         {
 116                 uint8_t KeyboardReport[Keyboard_HID_Interface.State.LargestReportSize];
 117                 HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
 118
 119                 for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 120                 {
 121                         HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 122
 123                         /* Update the report item value if it is contained within the current report */
 124                         if (!(USB_GetHIDReportItemInfo(KeyboardReport, ReportItem)))
 125                           continue;
 126
 127                         /* Determine what report item is being tested, process updated value as needed */
 128                         if ((ReportItem->Attributes.Usage.Page      == USAGE_PAGE_KEYBOARD) &&
 129                                 (ReportItem->Attributes.BitSize         == 8)                   &&
 130                                 (ReportItem->Attributes.Logical.Maximum > 1)                    &&
 131                                 (ReportItem->ItemType                   == HID_REPORT_ITEM_In))
 132                         {
 133                                 /* Key code is an unsigned char in length, cast to the appropriate type */
 134                                 uint8_t KeyCode = (uint8_t)ReportItem->Value;
 135
 136                                 /* If scan-code is non-zero, a key is being pressed */
 137                                 if (KeyCode)
 138                                 {
 139                                         /* Toggle status LED to indicate keypress */
 140                                         LEDs_ToggleLEDs(LEDS_LED2);
 141
 142                                         char PressedKey = 0;
 143
 144                                         /* Convert scan-code to printable character if alphanumeric */
 145                                         if ((KeyCode >= HID_KEYBOARD_SC_A) && (KeyCode <= HID_KEYBOARD_SC_Z))
 146                                         {
 147                                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_A) + 'A';
 148                                         }
 149                                         else if ((KeyCode >= HID_KEYBOARD_SC_1_AND_EXCLAMATION) &
 150                                                          (KeyCode  < HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS))
 151                                         {
 152                                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_1_AND_EXCLAMATION) + '1';
 153                                         }
 154                                         else if (KeyCode == HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS)
 155                                         {
 156                                                 PressedKey = '0';
 157                                         }
 158                                         else if (KeyCode == HID_KEYBOARD_SC_SPACE)
 159                                         {
 160                                                 PressedKey = ' ';
 161                                         }
 162                                         else if (KeyCode == HID_KEYBOARD_SC_ENTER)
 163                                         {
 164                                                 PressedKey = '\n';
 165                                         }
 166
 167                                         /* Print the pressed key character out through the serial port if valid */
 168                                         if (PressedKey)
 169                                           putchar(PressedKey);
 170                                 }
 171
 172                                 /* Once a scan-code is found, stop scanning through the report items */
 173                                 break;
 174                         }
 175                 }
 176         }
 177 }
 178
 179 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 180  *  starts the library USB task to begin the enumeration and USB management process.
 181  */
 182 void EVENT_USB_Host_DeviceAttached(void)
 183 {
 184         puts_P(PSTR("Device Attached.\r\n"));
 185         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 186 }
 187
 188 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 189  *  stops the library USB task management process.
 190  */
 191 void EVENT_USB_Host_DeviceUnattached(void)
 192 {
 193         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 194         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 195 }
 196
 197 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 198  *  enumerated by the host and is now ready to be used by the application.
 199  */
 200 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 201 {
 202         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 203
 204         uint16_t ConfigDescriptorSize;
 205         uint8_t  ConfigDescriptorData[512];
 206
 207         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 208                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 209         {
 210                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 211                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 212                 return;
 213         }
 214
 215         if (HID_Host_ConfigurePipes(&Keyboard_HID_Interface,
 216                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 217         {
 218                 puts_P(PSTR("Attached Device Not a Valid Keyboard.\r\n"));
 219                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 220                 return;
 221         }
 222
 223         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 224         {
 225                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 226                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 227                 return;
 228         }
 229
 230         if (HID_Host_SetReportProtocol(&Keyboard_HID_Interface) != 0)
 231         {
 232                 puts_P(PSTR("Error Setting Report Protocol Mode or Not a Valid Keyboard.\r\n"));
 233                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 234                 USB_Host_SetDeviceConfiguration(0);
 235                 return;
 236         }
 237
 238         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 239         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 240 }
 241
 242 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 243 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 244 {
 245         USB_Disable();
 246
 247         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 248                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 249
 250         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 251         for(;;);
 252 }
 253
 254 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 255  *  enumerating an attached USB device.
 256  */
 257 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 258                                             const uint8_t SubErrorCode)
 259 {
 260         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 261                                  " -- Error Code %d\r\n"
 262                                  " -- Sub Error Code %d\r\n"
 263                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 264
 265         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 266 }
 267
 268 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 269  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 270  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 271  *  have occupied).
 272  *
 273  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
 274  *
 275  *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
 276  */
 277 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
 278 {
 279         /* Check the attributes of the current item - see if we are interested in it or not;
 280          * only store KEYBOARD usage page items into the Processed HID Report structure to
 281          * save RAM and ignore the rest
 282          */
 283         return (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_KEYBOARD);
 284 }
 285