Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c

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