Demos/Host/LowLevel/KeyboardHost/KeyboardHost.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 KeyboardHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "KeyboardHost.h"
  38
  39 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_FG_CYAN "Keyboard HID Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         sei();
  50
  51         for (;;)
  52         {
  53                 Keyboard_HID_Task();
  54                 USB_USBTask();
  55         }
  56 }
  57
  58 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  59 void SetupHardware(void)
  60 {
  61         /* Disable watchdog if enabled by bootloader/fuses */
  62         MCUSR &= ~(1 << WDRF);
  63         wdt_disable();
  64
  65         /* Disable clock division */
  66         clock_prescale_set(clock_div_1);
  67
  68         /* Hardware Initialization */
  69         SerialStream_Init(9600, false);
  70         LEDs_Init();
  71         USB_Init();
  72 }
  73
  74 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  75  *  starts the library USB task to begin the enumeration and USB management process.
  76  */
  77 void EVENT_USB_Host_DeviceAttached(void)
  78 {
  79         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  80         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  81 }
  82
  83 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  84  *  stops the library USB task management process.
  85  */
  86 void EVENT_USB_Host_DeviceUnattached(void)
  87 {
  88         puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
  89         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  90 }
  91
  92 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  93  *  enumerated by the host and is now ready to be used by the application.
  94  */
  95 void EVENT_USB_Host_DeviceEnumerationComplete(void)
  96 {
  97         LEDs_SetAllLEDs(LEDMASK_USB_READY);
  98 }
  99
 100 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 101 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 102 {
 103         USB_ShutDown();
 104
 105         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 106                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 107
 108         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 109         for(;;);
 110 }
 111
 112 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 113  *  enumerating an attached USB device.
 114  */
 115 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 116 {
 117         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 118                                  " -- Error Code %d\r\n"
 119                                  " -- Sub Error Code %d\r\n"
 120                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 121
 122         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 123 }
 124
 125 /** Reads in and processes the next report from the attached device, displaying the report
 126  *  contents on the board LEDs and via the serial port.
 127  */
 128 void ReadNextReport(void)
 129 {
 130         USB_KeyboardReport_Data_t KeyboardReport;
 131
 132         /* Select keyboard data pipe */
 133         Pipe_SelectPipe(KEYBOARD_DATAPIPE);
 134
 135         /* Unfreeze keyboard data pipe */
 136         Pipe_Unfreeze();
 137
 138         /* Check to see if a packet has been received */
 139         if (!(Pipe_IsINReceived()))
 140         {
 141                 /* Refreeze HID data IN pipe */
 142                 Pipe_Freeze();
 143
 144                 return;
 145         }
 146
 147         /* Ensure pipe contains data before trying to read from it */
 148         if (Pipe_IsReadWriteAllowed())
 149         {
 150                 /* Read in keyboard report data */
 151                 Pipe_Read_Stream_LE(&KeyboardReport, sizeof(KeyboardReport));
 152
 153                 /* Indicate if the modifier byte is non-zero (special key such as shift is being pressed) */
 154                 LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 155
 156                 /* Check if a key has been pressed */
 157                 if (KeyboardReport.KeyCode)
 158                 {
 159                         /* Toggle status LED to indicate keypress */
 160                         LEDs_ToggleLEDs(LEDS_LED2);
 161
 162                         char PressedKey = 0;
 163
 164                         /* Retrieve pressed key character if alphanumeric */
 165                         if ((KeyboardReport.KeyCode[0] >= 0x04) && (KeyboardReport.KeyCode[0] <= 0x1D))
 166                           PressedKey = (KeyboardReport.KeyCode[0] - 0x04) + 'A';
 167                         else if ((KeyboardReport.KeyCode[0] >= 0x1E) && (KeyboardReport.KeyCode[0] <= 0x27))
 168                           PressedKey = (KeyboardReport.KeyCode[0] - 0x1E) + '0';
 169                         else if (KeyboardReport.KeyCode[0] == 0x2C)
 170                           PressedKey = ' ';
 171                         else if (KeyboardReport.KeyCode[0] == 0x28)
 172                           PressedKey = '\n';
 173
 174                         /* Print the pressed key character out through the serial port if valid */
 175                         if (PressedKey)
 176                           putchar(PressedKey);
 177                 }
 178         }
 179
 180         /* Clear the IN endpoint, ready for next data packet */
 181         Pipe_ClearIN();
 182
 183         /* Refreeze keyboard data pipe */
 184         Pipe_Freeze();
 185 }
 186
 187 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 188  *  HID reports from the device and display the results onto the board LEDs.
 189  */
 190 void Keyboard_HID_Task(void)
 191 {
 192         uint8_t ErrorCode;
 193
 194         switch (USB_HostState)
 195         {
 196                 case HOST_STATE_Addressed:
 197                         puts_P(PSTR("Getting Config Data.\r\n"));
 198
 199                         /* Get and process the configuration descriptor data */
 200                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 201                         {
 202                                 if (ErrorCode == ControlError)
 203                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 204                                 else
 205                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 206
 207                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 208
 209                                 /* Indicate error status */
 210                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 211
 212                                 /* Wait until USB device disconnected */
 213                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 214                                 break;
 215                         }
 216
 217                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 218                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 219                         {
 220                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 221                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 222
 223                                 /* Indicate error status */
 224                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 225
 226                                 /* Wait until USB device disconnected */
 227                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 228                                 break;
 229                         }
 230
 231                         /* HID class request to set the keyboard protocol to the Boot Protocol */
 232                         USB_ControlRequest = (USB_Request_Header_t)
 233                                 {
 234                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 235                                         .bRequest      = REQ_SetProtocol,
 236                                         .wValue        = 0,
 237                                         .wIndex        = 0,
 238                                         .wLength       = 0,
 239                                 };
 240
 241                         /* Select the control pipe for the request transfer */
 242                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 243
 244                         /* Send the request, display error and wait for device detach if request fails */
 245                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 246                         {
 247                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Protocol).\r\n"
 248                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 249
 250                                 /* Indicate error status */
 251                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 252
 253                                 /* Wait until USB device disconnected */
 254                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 255                                 break;
 256                         }
 257
 258                         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 259
 260                         USB_HostState = HOST_STATE_Configured;
 261                         break;
 262                 case HOST_STATE_Configured:
 263                         /* If a report has been received, read and process it */
 264                         ReadNextReport();
 265
 266                         break;
 267         }
 268 }