Demos/Host/LowLevel/KeyboardHost/KeyboardHost.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 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  *  starts the scheduler to run the application tasks.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
  47                "Keyboard HID Host Demo running.\r\n" ESC_INVERSE_OFF));
  48
  49         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  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_DeviceAttached(void)
  78 {
  79         puts_P(PSTR("Device Attached.\r\n"));
  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_DeviceUnattached(void)
  87 {
  88         puts_P(PSTR("Device Unattached.\r\n"));
  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_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_HostError(const uint8_t ErrorCode)
 102 {
 103         USB_ShutDown();
 104
 105         puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
 106         printf_P(PSTR(" -- Error Code %d\r\n"), 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_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 116 {
 117         puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
 118         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 119         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 120         printf_P(PSTR(" -- In State %d\r\n"), 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                         if (LEDs_GetLEDs() & LEDS_LED2)
 161                           LEDs_TurnOffLEDs(LEDS_LED2);
 162                         else
 163                           LEDs_TurnOnLEDs(LEDS_LED2);
 164
 165                         char PressedKey = 0;
 166
 167                         /* Retrieve pressed key character if alphanumeric */
 168                         if ((KeyboardReport.KeyCode >= 0x04) && (KeyboardReport.KeyCode <= 0x1D))
 169                           PressedKey = (KeyboardReport.KeyCode - 0x04) + 'A';
 170                         else if ((KeyboardReport.KeyCode >= 0x1E) && (KeyboardReport.KeyCode <= 0x27))
 171                           PressedKey = (KeyboardReport.KeyCode - 0x1E) + '0';
 172                         else if (KeyboardReport.KeyCode == 0x2C)
 173                           PressedKey = ' ';
 174                         else if (KeyboardReport.KeyCode == 0x28)
 175                           PressedKey = '\n';
 176
 177                         /* Print the pressed key character out through the serial port if valid */
 178                         if (PressedKey)
 179                           putchar(PressedKey);
 180                 }
 181         }
 182
 183         /* Clear the IN endpoint, ready for next data packet */
 184         Pipe_ClearIN();
 185
 186         /* Refreeze keyboard data pipe */
 187         Pipe_Freeze();
 188 }
 189
 190 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 191  *  HID reports from the device and display the results onto the board LEDs.
 192  */
 193 void Keyboard_HID_Task(void)
 194 {
 195         uint8_t ErrorCode;
 196
 197         switch (USB_HostState)
 198         {
 199                 case HOST_STATE_Addressed:
 200                         puts_P(PSTR("Getting Config Data.\r\n"));
 201
 202                         /* Get and process the configuration descriptor data */
 203                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 204                         {
 205                                 if (ErrorCode == ControlError)
 206                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 207                                 else
 208                                   puts_P(PSTR("Invalid Device.\r\n"));
 209
 210                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 211
 212                                 /* Indicate error status */
 213                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 214
 215                                 /* Wait until USB device disconnected */
 216                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 217                                 break;
 218                         }
 219
 220                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 221                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 222                         {
 223                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 224                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 225
 226                                 /* Indicate error status */
 227                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 228
 229                                 /* Wait until USB device disconnected */
 230                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 231                                 break;
 232                         }
 233
 234                         USB_HostState = HOST_STATE_Configured;
 235                         break;
 236                 case HOST_STATE_Configured:
 237                         /* HID class request to set the keyboard protocol to the Boot Protocol */
 238                         USB_ControlRequest = (USB_Request_Header_t)
 239                                 {
 240                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 241                                         .bRequest      = REQ_SetProtocol,
 242                                         .wValue        = 0,
 243                                         .wIndex        = 0,
 244                                         .wLength       = 0,
 245                                 };
 246
 247                         /* Select the control pipe for the request transfer */
 248                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 249
 250                         /* Send the request, display error and wait for device detach if request fails */
 251                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 252                         {
 253                                 puts_P(PSTR("Control Error (Set Protocol).\r\n"));
 254                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 255
 256                                 /* Indicate error status */
 257                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 258
 259                                 /* Wait until USB device disconnected */
 260                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 261                                 break;
 262                         }
 263
 264                         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 265
 266                         USB_HostState = HOST_STATE_Ready;
 267                         break;
 268                 case HOST_STATE_Ready:
 269                         /* If a report has been received, read and process it */
 270                         ReadNextReport();
 271
 272                         break;
 273         }
 274 }