Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c

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