Demos/Host/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 /* Project Tags, for reading out using the ButtLoad project */
  40 BUTTLOADTAG(ProjName,    "LUFA KBD Host App");
  41 BUTTLOADTAG(BuildTime,   __TIME__);
  42 BUTTLOADTAG(BuildDate,   __DATE__);
  43 BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);
  44
  45 /* Scheduler Task List */
  46 TASK_LIST
  47 {
  48         { Task: USB_USBTask          , TaskStatus: TASK_STOP },
  49         { Task: USB_Keyboard_Host    , TaskStatus: TASK_STOP },
  50 };
  51
  52
  53 /** Main program entry point. This routine configures the hardware required by the application, then
  54  *  starts the scheduler to run the application tasks.
  55  */
  56 int main(void)
  57 {
  58         /* Disable watchdog if enabled by bootloader/fuses */
  59         MCUSR &= ~(1 << WDRF);
  60         wdt_disable();
  61
  62         /* Disable clock division */
  63         clock_prescale_set(clock_div_1);
  64
  65         /* Hardware Initialization */
  66         SerialStream_Init(9600, false);
  67         LEDs_Init();
  68
  69         /* Indicate USB not ready */
  70         UpdateStatus(Status_USBNotReady);
  71
  72         /* Initialize Scheduler so that it can be used */
  73         Scheduler_Init();
  74
  75         /* Initialize USB Subsystem */
  76         USB_Init();
  77
  78         /* Startup message */
  79         puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
  80                "Keyboard Host Demo running.\r\n" ESC_INVERSE_OFF));
  81
  82         /* Scheduling - routine never returns, so put this last in the main function */
  83         Scheduler_Start();
  84 }
  85
  86 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  87  *  starts the library USB task to begin the enumeration and USB management process.
  88  */
  89 EVENT_HANDLER(USB_DeviceAttached)
  90 {
  91         puts_P(PSTR("Device Attached.\r\n"));
  92         UpdateStatus(Status_USBEnumerating);
  93
  94         /* Start USB management task to enumerate the device */
  95         Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
  96 }
  97
  98 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  99  *  stops the library USB task management process.
 100  */
 101 EVENT_HANDLER(USB_DeviceUnattached)
 102 {
 103         /* Stop Keyboard and USB management task */
 104         Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
 105         Scheduler_SetTaskMode(USB_Keyboard_Host, TASK_STOP);
 106
 107         puts_P(PSTR("Device Unattached.\r\n"));
 108         UpdateStatus(Status_USBNotReady);
 109 }
 110
 111 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 112  *  enumerated by the host and is now ready to be used by the application.
 113  */
 114 EVENT_HANDLER(USB_DeviceEnumerationComplete)
 115 {
 116         /* Start Keyboard Host task */
 117         Scheduler_SetTaskMode(USB_Keyboard_Host, TASK_RUN);
 118
 119         /* Indicate device enumeration complete */
 120         UpdateStatus(Status_USBReady);
 121 }
 122
 123 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 124 EVENT_HANDLER(USB_HostError)
 125 {
 126         USB_ShutDown();
 127
 128         puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
 129         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 130
 131         UpdateStatus(Status_HardwareError);
 132         for(;;);
 133 }
 134
 135 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
 136  *  enumerating an attached USB device.
 137  */
 138 EVENT_HANDLER(USB_DeviceEnumerationFailed)
 139 {
 140         puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
 141         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 142         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 143         printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);
 144
 145         UpdateStatus(Status_EnumerationError);
 146 }
 147
 148 /** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
 149  *  log to a serial port, or anything else that is suitable for status updates.
 150  *
 151  *  \param CurrentStatus  Current status of the system, from the KeyboardHost_StatusCodes_t enum
 152  */
 153 void UpdateStatus(uint8_t CurrentStatus)
 154 {
 155         uint8_t LEDMask = LEDS_NO_LEDS;
 156
 157         /* Set the LED mask to the appropriate LED mask based on the given status code */
 158         switch (CurrentStatus)
 159         {
 160                 case Status_USBNotReady:
 161                         LEDMask = (LEDS_LED1);
 162                         break;
 163                 case Status_USBEnumerating:
 164                         LEDMask = (LEDS_LED1 | LEDS_LED2);
 165                         break;
 166                 case Status_USBReady:
 167                         LEDMask = (LEDS_LED2);
 168                         break;
 169                 case Status_EnumerationError:
 170                 case Status_HardwareError:
 171                         LEDMask = (LEDS_LED1 | LEDS_LED3);
 172                         break;
 173         }
 174
 175         /* Set the board LEDs to the new LED mask */
 176         LEDs_SetAllLEDs(LEDMask);
 177 }
 178
 179 /** Reads in and processes the next report from the attached device, displaying the report
 180  *  contents on the board LEDs and via the serial port.
 181  */
 182 void ReadNextReport(void)
 183 {
 184         USB_KeyboardReport_Data_t KeyboardReport;
 185
 186         /* Select the keyboard report data in pipe */
 187         Pipe_SelectPipe(KEYBOARD_DATAPIPE);
 188
 189         /* Ensure pipe contains data and is ready to be read before continuing */
 190         if (!(Pipe_ReadWriteAllowed()))
 191           return;
 192
 193         /* Read in keyboard report data */
 194         Pipe_Read_Stream_LE(&KeyboardReport, sizeof(KeyboardReport));
 195
 196         /* Clear the IN endpoint, ready for next data packet */
 197         Pipe_ClearCurrentBank();
 198
 199         /* Indicate if the modifier byte is non-zero (special key such as shift is being pressed) */
 200         LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 201
 202         /* Check if a key has been pressed */
 203         if (KeyboardReport.KeyCode)
 204         {
 205                 /* Toggle status LED to indicate keypress */
 206                 if (LEDs_GetLEDs() & LEDS_LED2)
 207                   LEDs_TurnOffLEDs(LEDS_LED2);
 208                 else
 209                   LEDs_TurnOnLEDs(LEDS_LED2);
 210
 211                 char PressedKey = 0;
 212
 213                 /* Retrieve pressed key character if alphanumeric */
 214                 if ((KeyboardReport.KeyCode >= 0x04) && (KeyboardReport.KeyCode <= 0x1D))
 215                   PressedKey = (KeyboardReport.KeyCode - 0x04) + 'A';
 216                 else if ((KeyboardReport.KeyCode >= 0x1E) && (KeyboardReport.KeyCode <= 0x27))
 217                   PressedKey = (KeyboardReport.KeyCode - 0x1E) + '0';
 218                 else if (KeyboardReport.KeyCode == 0x2C)
 219                   PressedKey = ' ';
 220                 else if (KeyboardReport.KeyCode == 0x28)
 221                   PressedKey = '\n';
 222
 223                 /* Print the pressed key character out through the serial port if valid */
 224                 if (PressedKey)
 225                   putchar(PressedKey);
 226         }
 227 }
 228
 229 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 230  *  HID reports from the device and display the results onto the board LEDs.
 231  */
 232 TASK(USB_Keyboard_Host)
 233 {
 234         uint8_t ErrorCode;
 235
 236         switch (USB_HostState)
 237         {
 238                 case HOST_STATE_Addressed:
 239                         /* Standard request to set the device configuration to configuration 1 */
 240                         USB_HostRequest = (USB_Host_Request_Header_t)
 241                                 {
 242                                         bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 243                                         bRequest:      REQ_SetConfiguration,
 244                                         wValue:        1,
 245                                         wIndex:        0,
 246                                         wLength:       0,
 247                                 };
 248
 249                         /* Send the request, display error and wait for device detatch if request fails */
 250                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 251                         {
 252                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 253                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 254
 255                                 /* Indicate error status */
 256                                 UpdateStatus(Status_EnumerationError);
 257
 258                                 /* Wait until USB device disconnected */
 259                                 while (USB_IsConnected);
 260                                 break;
 261                         }
 262
 263                         USB_HostState = HOST_STATE_Configured;
 264                         break;
 265                 case HOST_STATE_Configured:
 266                         puts_P(PSTR("Getting Config Data.\r\n"));
 267
 268                         /* Get and process the configuration descriptor data */
 269                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 270                         {
 271                                 if (ErrorCode == ControlError)
 272                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 273                                 else
 274                                   puts_P(PSTR("Invalid Device.\r\n"));
 275
 276                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 277
 278                                 /* Indicate error status */
 279                                 UpdateStatus(Status_EnumerationError);
 280
 281                                 /* Wait until USB device disconnected */
 282                                 while (USB_IsConnected);
 283                                 break;
 284                         }
 285
 286                         /* HID class request to set the keyboard protocol to the Boot Protocol */
 287                         USB_HostRequest = (USB_Host_Request_Header_t)
 288                                 {
 289                                         bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 290                                         bRequest:      REQ_SetProtocol,
 291                                         wValue:        0,
 292                                         wIndex:        0,
 293                                         wLength:       0,
 294                                 };
 295
 296                         /* Send the request, display error and wait for device detatch if request fails */
 297                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 298                         {
 299                                 puts_P(PSTR("Control Error (Set Protocol).\r\n"));
 300                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 301
 302                                 /* Indicate error status */
 303                                 UpdateStatus(Status_EnumerationError);
 304
 305                                 /* Wait until USB device disconnected */
 306                                 while (USB_IsConnected);
 307                                 break;
 308                         }
 309
 310                         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 311
 312                         USB_HostState = HOST_STATE_Ready;
 313                         break;
 314                 #if !defined(INTERRUPT_DATA_PIPE)
 315                 case HOST_STATE_Ready:
 316                         /* Select and unfreeze keyboard data pipe */
 317                         Pipe_SelectPipe(KEYBOARD_DATAPIPE);
 318                         Pipe_Unfreeze();
 319
 320                         /* If a report has been received, read and process it */
 321                         if (Pipe_ReadWriteAllowed())
 322                           ReadNextReport();
 323
 324                         /* Freeze keyboard data pipe */
 325                         Pipe_Freeze();
 326                         break;
 327                 #endif
 328         }
 329 }
 330
 331 #if defined(INTERRUPT_DATA_PIPE)
 332 /** Interrupt handler for the Endpoint/Pipe interrupt vector. This interrupt fires each time an enabled
 333  *  pipe interrupt occurs on a pipe which has had that interrupt enabled.
 334  */
 335 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
 336 {
 337         /* Check to see if the keyboard data pipe has caused the interrupt */
 338         if (Pipe_HasPipeInterrupted(KEYBOARD_DATAPIPE))
 339         {
 340                 /* Clear the pipe interrupt, and select the keyboard pipe */
 341                 Pipe_ClearPipeInterrupt(KEYBOARD_DATAPIPE);
 342                 Pipe_SelectPipe(KEYBOARD_DATAPIPE);
 343
 344                 /* Check to see if the pipe IN interrupt has fired */
 345                 if (USB_INT_HasOccurred(PIPE_INT_IN) && USB_INT_IsEnabled(PIPE_INT_IN))
 346                 {
 347                         /* Clear interrupt flag */
 348                         USB_INT_Clear(PIPE_INT_IN);
 349
 350                         /* Read and process the next report from the device */
 351                         ReadNextReport();
 352         }
 353 }
 354 #endif