Demos/Device/Keyboard/Keyboard.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  Denver Gingerich (denver [at] ossguy [dot] com)
  11       Based on code by Dean Camera (dean [at] fourwalledcubicle [dot] com)
  12
  13   Permission to use, copy, modify, and distribute this software
  14   and its documentation for any purpose and without fee is hereby
  15   granted, provided that the above copyright notice appear in all
  16   copies and that both that the copyright notice and this
  17   permission notice and warranty disclaimer appear in supporting
  18   documentation, and that the name of the author not be used in
  19   advertising or publicity pertaining to distribution of the
  20   software without specific, written prior permission.
  21
  22   The author disclaim all warranties with regard to this
  23   software, including all implied warranties of merchantability
  24   and fitness.  In no event shall the author be liable for any
  25   special, indirect or consequential damages or any damages
  26   whatsoever resulting from loss of use, data or profits, whether
  27   in an action of contract, negligence or other tortious action,
  28   arising out of or in connection with the use or performance of
  29   this software.
  30 */
  31
  32 /** \file
  33  *
  34  *  Main source file for the Keyboard demo. This file contains the main tasks of the demo and
  35  *  is responsible for the initial application hardware configuration.
  36  */
  37
  38 #include "Keyboard.h"
  39
  40 /* Scheduler Task List */
  41 TASK_LIST
  42 {
  43         #if !defined(INTERRUPT_CONTROL_ENDPOINT)
  44         { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },
  45         #endif
  46
  47         #if !defined(INTERRUPT_DATA_ENDPOINT)
  48         { .Task = USB_Keyboard_Report  , .TaskStatus = TASK_STOP },
  49         #endif
  50 };
  51
  52 /* Global Variables */
  53 /** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot
  54  *  protocol reporting mode.
  55  */
  56 bool UsingReportProtocol = true;
  57
  58 /** Current Idle period. This is set by the host via a Set Idle HID class request to silence the device's reports
  59  *  for either the entire idle duration, or until the report status changes (e.g. the user moves the mouse).
  60  */
  61 uint8_t IdleCount = 0;
  62
  63 /** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle
  64  *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request
  65  *  the current idle period via a Get Idle HID class request, thus its value must be preserved.
  66  */
  67 uint16_t IdleMSRemaining = 0;
  68
  69
  70 /** Main program entry point. This routine configures the hardware required by the application, then
  71  *  starts the scheduler to run the USB management task.
  72  */
  73 int main(void)
  74 {
  75         /* Disable watchdog if enabled by bootloader/fuses */
  76         MCUSR &= ~(1 << WDRF);
  77         wdt_disable();
  78
  79         /* Disable clock division */
  80         clock_prescale_set(clock_div_1);
  81
  82         /* Hardware Initialization */
  83         Joystick_Init();
  84         LEDs_Init();
  85
  86         /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */
  87         OCR0A  = 0x7D;
  88         TCCR0A = (1 << WGM01);
  89         TCCR0B = ((1 << CS01) | (1 << CS00));
  90         TIMSK0 = (1 << OCIE0A);
  91
  92         /* Indicate USB not ready */
  93         UpdateStatus(Status_USBNotReady);
  94
  95         /* Initialize Scheduler so that it can be used */
  96         Scheduler_Init();
  97
  98         /* Initialize USB Subsystem */
  99         USB_Init();
 100
 101         /* Scheduling - routine never returns, so put this last in the main function */
 102         Scheduler_Start();
 103 }
 104
 105 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
 106  *  starts the library USB task to begin the enumeration and USB management process.
 107  */
 108 EVENT_HANDLER(USB_Connect)
 109 {
 110         #if !defined(INTERRUPT_CONTROL_ENDPOINT)
 111         /* Start USB management task */
 112         Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
 113         #endif
 114
 115         /* Indicate USB enumerating */
 116         UpdateStatus(Status_USBEnumerating);
 117
 118         /* Default to report protocol on connect */
 119         UsingReportProtocol = true;
 120 }
 121
 122 /** Event handler for the USB_Reset event. This fires when the USB interface is reset by the USB host, before the
 123  *  enumeration process begins, and enables the control endpoint interrupt so that control requests can be handled
 124  *  asynchronously when they arrive rather than when the control endpoint is polled manually.
 125  */
 126 EVENT_HANDLER(USB_Reset)
 127 {
 128         #if defined(INTERRUPT_CONTROL_ENDPOINT)
 129         /* Select the control endpoint */
 130         Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);
 131
 132         /* Enable the endpoint SETUP interrupt ISR for the control endpoint */
 133         USB_INT_Enable(ENDPOINT_INT_SETUP);
 134         #endif
 135 }
 136
 137 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
 138  *  the status LEDs.
 139  */
 140 EVENT_HANDLER(USB_Disconnect)
 141 {
 142         /* Stop running keyboard reporting and USB management tasks */
 143         #if !defined(INTERRUPT_DATA_ENDPOINT)
 144         Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_STOP);
 145         #endif
 146
 147         #if !defined(INTERRUPT_CONTROL_ENDPOINT)
 148         Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
 149         #endif
 150
 151         /* Indicate USB not ready */
 152         UpdateStatus(Status_USBNotReady);
 153 }
 154
 155 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration
 156  *  of the USB device after enumeration, and configures the keyboard device endpoints.
 157  */
 158 EVENT_HANDLER(USB_ConfigurationChanged)
 159 {
 160         /* Setup Keyboard Keycode Report Endpoint */
 161         Endpoint_ConfigureEndpoint(KEYBOARD_EPNUM, EP_TYPE_INTERRUPT,
 162                                        ENDPOINT_DIR_IN, KEYBOARD_EPSIZE,
 163                                    ENDPOINT_BANK_SINGLE);
 164
 165         #if defined(INTERRUPT_DATA_ENDPOINT)
 166         /* Enable the endpoint IN interrupt ISR for the report endpoint */
 167         USB_INT_Enable(ENDPOINT_INT_IN);
 168         #endif
 169
 170         /* Setup Keyboard LED Report Endpoint */
 171         Endpoint_ConfigureEndpoint(KEYBOARD_LEDS_EPNUM, EP_TYPE_INTERRUPT,
 172                                        ENDPOINT_DIR_OUT, KEYBOARD_EPSIZE,
 173                                    ENDPOINT_BANK_SINGLE);
 174
 175         #if defined(INTERRUPT_DATA_ENDPOINT)
 176         /* Enable the endpoint OUT interrupt ISR for the LED report endpoint */
 177         USB_INT_Enable(ENDPOINT_INT_OUT);
 178         #endif
 179
 180         /* Indicate USB connected and ready */
 181         UpdateStatus(Status_USBReady);
 182
 183         #if !defined(INTERRUPT_DATA_ENDPOINT)
 184         /* Start running keyboard reporting task */
 185         Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_RUN);
 186         #endif
 187 }
 188
 189 /** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific
 190  *  control requests that are not handled internally by the USB library (including the HID commands, which are
 191  *  all issued via the control endpoint), so that they can be handled appropriately for the application.
 192  */
 193 EVENT_HANDLER(USB_UnhandledControlPacket)
 194 {
 195         /* Handle HID Class specific requests */
 196         switch (USB_ControlRequest.bRequest)
 197         {
 198                 case REQ_GetReport:
 199                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 200                         {
 201                                 USB_KeyboardReport_Data_t KeyboardReportData;
 202
 203                                 Endpoint_ClearSETUP();
 204
 205                                 /* Create the next keyboard report for transmission to the host */
 206                                 CreateKeyboardReport(&KeyboardReportData);
 207
 208                                 /* Write the report data to the control endpoint */
 209                                 Endpoint_Write_Control_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
 210
 211                                 /* Finalize the stream transfer to send the last packet or clear the host abort */
 212                                 Endpoint_ClearOUT();
 213                         }
 214
 215                         break;
 216                 case REQ_SetReport:
 217                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 218                         {
 219                                 Endpoint_ClearSETUP();
 220
 221                                 /* Wait until the LED report has been sent by the host */
 222                                 while (!(Endpoint_IsOUTReceived()));
 223
 224                                 /* Read in the LED report from the host */
 225                                 uint8_t LEDStatus = Endpoint_Read_Byte();
 226
 227                                 /* Process the incoming LED report */
 228                                 ProcessLEDReport(LEDStatus);
 229
 230                                 /* Clear the endpoint data */
 231                                 Endpoint_ClearOUT();
 232
 233                                 /* Acknowledge status stage */
 234                                 while (!(Endpoint_IsINReady()));
 235                                 Endpoint_ClearIN();
 236                         }
 237
 238                         break;
 239                 case REQ_GetProtocol:
 240                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 241                         {
 242                                 Endpoint_ClearSETUP();
 243
 244                                 /* Write the current protocol flag to the host */
 245                                 Endpoint_Write_Byte(UsingReportProtocol);
 246
 247                                 /* Send the flag to the host */
 248                                 Endpoint_ClearIN();
 249
 250                                 /* Acknowledge status stage */
 251                                 while (!(Endpoint_IsOUTReceived()));
 252                                 Endpoint_ClearOUT();
 253                         }
 254
 255                         break;
 256                 case REQ_SetProtocol:
 257                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 258                         {
 259                                 Endpoint_ClearSETUP();
 260
 261                                 /* Set or clear the flag depending on what the host indicates that the current Protocol should be */
 262                                 UsingReportProtocol = (USB_ControlRequest.wValue != 0x0000);
 263
 264                                 /* Acknowledge status stage */
 265                                 while (!(Endpoint_IsINReady()));
 266                                 Endpoint_ClearIN();
 267                         }
 268
 269                         break;
 270                 case REQ_SetIdle:
 271                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 272                         {
 273                                 Endpoint_ClearSETUP();
 274
 275                                 /* Get idle period in MSB */
 276                                 IdleCount = (USB_ControlRequest.wValue >> 8);
 277
 278                                 /* Acknowledge status stage */
 279                                 while (!(Endpoint_IsINReady()));
 280                                 Endpoint_ClearIN();
 281                         }
 282
 283                         break;
 284                 case REQ_GetIdle:
 285                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 286                         {
 287                                 Endpoint_ClearSETUP();
 288
 289                                 /* Write the current idle duration to the host */
 290                                 Endpoint_Write_Byte(IdleCount);
 291
 292                                 /* Send the flag to the host */
 293                                 Endpoint_ClearIN();
 294
 295                                 /* Acknowledge status stage */
 296                                 while (!(Endpoint_IsOUTReceived()));
 297                                 Endpoint_ClearOUT();
 298                         }
 299
 300                         break;
 301         }
 302 }
 303
 304 /** ISR for the timer 0 compare vector. This ISR fires once each millisecond, and increments the
 305  *  scheduler elapsed idle period counter when the host has set an idle period.
 306  */
 307 ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 308 {
 309         /* One millisecond has elapsed, decrement the idle time remaining counter if it has not already elapsed */
 310         if (IdleMSRemaining)
 311           IdleMSRemaining--;
 312 }
 313
 314 /** Fills the given HID report data structure with the next HID report to send to the host.
 315  *
 316  *  \param ReportData  Pointer to a HID report data structure to be filled
 317  */
 318 void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData)
 319 {
 320         uint8_t JoyStatus_LCL = Joystick_GetStatus();
 321
 322         /* Clear the report contents */
 323         memset(ReportData, 0, sizeof(USB_KeyboardReport_Data_t));
 324
 325         if (JoyStatus_LCL & JOY_UP)
 326           ReportData->KeyCode[0] = 0x04; // A
 327         else if (JoyStatus_LCL & JOY_DOWN)
 328           ReportData->KeyCode[0] = 0x05; // B
 329
 330         if (JoyStatus_LCL & JOY_LEFT)
 331           ReportData->KeyCode[0] = 0x06; // C
 332         else if (JoyStatus_LCL & JOY_RIGHT)
 333           ReportData->KeyCode[0] = 0x07; // D
 334
 335         if (JoyStatus_LCL & JOY_PRESS)
 336           ReportData->KeyCode[0] = 0x08; // E
 337 }
 338
 339 /** Processes a received LED report, and updates the board LEDs states to match.
 340  *
 341  *  \param LEDReport  LED status report from the host
 342  */
 343 void ProcessLEDReport(uint8_t LEDReport)
 344 {
 345         uint8_t LEDMask = LEDS_LED2;
 346
 347         if (LEDReport & 0x01) // NUM Lock
 348           LEDMask |= LEDS_LED1;
 349
 350         if (LEDReport & 0x02) // CAPS Lock
 351           LEDMask |= LEDS_LED3;
 352
 353         if (LEDReport & 0x04) // SCROLL Lock
 354           LEDMask |= LEDS_LED4;
 355
 356         /* Set the status LEDs to the current Keyboard LED status */
 357         LEDs_SetAllLEDs(LEDMask);
 358 }
 359
 360 /** Sends the next HID report to the host, via the keyboard data endpoint. */
 361 static inline void SendNextReport(void)
 362 {
 363         static USB_KeyboardReport_Data_t PrevKeyboardReportData;
 364         USB_KeyboardReport_Data_t        KeyboardReportData;
 365         bool                             SendReport = true;
 366
 367         /* Create the next keyboard report for transmission to the host */
 368         CreateKeyboardReport(&KeyboardReportData);
 369
 370         /* Check if the idle period is set */
 371         if (IdleCount)
 372         {
 373                 /* Check if idle period has elapsed */
 374                 if (!(IdleMSRemaining))
 375                 {
 376                         /* Reset the idle time remaining counter, must multiply by 4 to get the duration in milliseconds */
 377                         IdleMSRemaining = (IdleCount << 2);
 378                 }
 379                 else
 380                 {
 381                         /* Idle period not elapsed, indicate that a report must not be sent unless the report has changed */
 382                         SendReport = (memcmp(&PrevKeyboardReportData, &KeyboardReportData, sizeof(USB_KeyboardReport_Data_t)) != 0);
 383                 }
 384         }
 385
 386         /* Save the current report data for later comparison to check for changes */
 387         PrevKeyboardReportData = KeyboardReportData;
 388
 389         /* Select the Keyboard Report Endpoint */
 390         Endpoint_SelectEndpoint(KEYBOARD_EPNUM);
 391
 392         /* Check if Keyboard Endpoint Ready for Read/Write, and if we should send a report */
 393         if (Endpoint_IsReadWriteAllowed() && SendReport)
 394         {
 395                 /* Write Keyboard Report Data */
 396                 Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
 397
 398                 /* Finalize the stream transfer to send the last packet */
 399                 Endpoint_ClearIN();
 400         }
 401 }
 402
 403 /** Reads the next LED status report from the host from the LED data endpoint, if one has been sent. */
 404 static inline void ReceiveNextReport(void)
 405 {
 406         /* Select the Keyboard LED Report Endpoint */
 407         Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);
 408
 409         /* Check if Keyboard LED Endpoint contains a packet */
 410         if (Endpoint_IsOUTReceived())
 411         {
 412                 /* Check to see if the packet contains data */
 413                 if (Endpoint_IsReadWriteAllowed())
 414                 {
 415                         /* Read in the LED report from the host */
 416                         uint8_t LEDReport = Endpoint_Read_Byte();
 417
 418                         /* Process the read LED report from the host */
 419                         ProcessLEDReport(LEDReport);
 420                 }
 421
 422                 /* Handshake the OUT Endpoint - clear endpoint and ready for next report */
 423                 Endpoint_ClearOUT();
 424         }
 425 }
 426
 427 /** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
 428  *  log to a serial port, or anything else that is suitable for status updates.
 429  *
 430  *  \param CurrentStatus  Current status of the system, from the Keyboard_StatusCodes_t enum
 431  */
 432 void UpdateStatus(uint8_t CurrentStatus)
 433 {
 434         uint8_t LEDMask = LEDS_NO_LEDS;
 435
 436         /* Set the LED mask to the appropriate LED mask based on the given status code */
 437         switch (CurrentStatus)
 438         {
 439                 case Status_USBNotReady:
 440                         LEDMask = (LEDS_LED1);
 441                         break;
 442                 case Status_USBEnumerating:
 443                         LEDMask = (LEDS_LED1 | LEDS_LED2);
 444                         break;
 445                 case Status_USBReady:
 446                         LEDMask = (LEDS_LED2 | LEDS_LED4);
 447                         break;
 448         }
 449
 450         /* Set the board LEDs to the new LED mask */
 451         LEDs_SetAllLEDs(LEDMask);
 452 }
 453
 454 #if !defined(INTERRUPT_DATA_ENDPOINT)
 455 /** Function to manage HID report generation and transmission to the host, when in report mode. */
 456 TASK(USB_Keyboard_Report)
 457 {
 458         /* Check if the USB system is connected to a host */
 459         if (USB_IsConnected)
 460         {
 461                 /* Send the next keypress report to the host */
 462                 SendNextReport();
 463
 464                 /* Process the LED report sent from the host */
 465                 ReceiveNextReport();
 466         }
 467 }
 468 #endif
 469
 470 /** ISR for the general Pipe/Endpoint interrupt vector. This ISR fires when an endpoint's status changes (such as
 471  *  a packet has been received) on an endpoint with its corresponding ISR enabling bits set. This is used to send
 472  *  HID packets to the host each time the HID interrupt endpoints polling period elapses, as managed by the USB
 473  *  controller. It is also used to respond to standard and class specific requests send to the device on the control
 474  *  endpoint, by handing them off to the LUFA library when they are received.
 475  */
 476 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
 477 {
 478         #if defined(INTERRUPT_CONTROL_ENDPOINT)
 479         /* Check if the control endpoint has received a request */
 480         if (Endpoint_HasEndpointInterrupted(ENDPOINT_CONTROLEP))
 481         {
 482                 /* Clear the endpoint interrupt */
 483                 Endpoint_ClearEndpointInterrupt(ENDPOINT_CONTROLEP);
 484
 485                 /* Process the control request */
 486                 USB_USBTask();
 487
 488                 /* Handshake the endpoint setup interrupt - must be after the call to USB_USBTask() */
 489                 USB_INT_Clear(ENDPOINT_INT_SETUP);
 490         }
 491         #endif
 492
 493         #if defined(INTERRUPT_DATA_ENDPOINT)
 494         /* Check if keyboard endpoint has interrupted */
 495         if (Endpoint_HasEndpointInterrupted(KEYBOARD_EPNUM))
 496         {
 497                 /* Select the Keyboard Report Endpoint */
 498                 Endpoint_SelectEndpoint(KEYBOARD_EPNUM);
 499
 500                 /* Clear the endpoint IN interrupt flag */
 501                 USB_INT_Clear(ENDPOINT_INT_IN);
 502
 503                 /* Clear the Keyboard Report endpoint interrupt */
 504                 Endpoint_ClearEndpointInterrupt(KEYBOARD_EPNUM);
 505
 506                 /* Send the next keypress report to the host */
 507                 SendNextReport();
 508         }
 509
 510         /* Check if Keyboard LED status Endpoint has interrupted */
 511         if (Endpoint_HasEndpointInterrupted(KEYBOARD_LEDS_EPNUM))
 512         {
 513                 /* Select the Keyboard LED Report Endpoint */
 514                 Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);
 515
 516                 /* Clear the endpoint OUT interrupt flag */
 517                 USB_INT_Clear(ENDPOINT_INT_OUT);
 518
 519                 /* Clear the Keyboard LED Report endpoint interrupt */
 520                 Endpoint_ClearEndpointInterrupt(KEYBOARD_LEDS_EPNUM);
 521
 522                 /* Process the LED report sent from the host */
 523                 ReceiveNextReport();
 524         }
 525         #endif
 526 }