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