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