Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c

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