Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c

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