Demos/Device/LowLevel/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 /* Global Variables */
  41 /** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot
  42  *  protocol reporting mode.
  43  */
  44 bool UsingReportProtocol = true;
  45
  46 /** Current Idle period. This is set by the host via a Set Idle HID class request to silence the device's reports
  47  *  for either the entire idle duration, or until the report status changes (e.g. the user presses a key).
  48  */
  49 uint16_t IdleCount = 500;
  50
  51 /** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle
  52  *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request
  53  *  the current idle period via a Get Idle HID class request, thus its value must be preserved.
  54  */
  55 uint16_t IdleMSRemaining = 0;
  56
  57
  58 /** Main program entry point. This routine configures the hardware required by the application, then
  59  *  starts the scheduler to run the USB management task.
  60  */
  61 int main(void)
  62 {
  63         SetupHardware();
  64
  65         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  66
  67         for (;;)
  68         {
  69                 HID_Task();
  70                 USB_USBTask();
  71         }
  72 }
  73
  74 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  75 void SetupHardware(void)
  76 {
  77         /* Disable watchdog if enabled by bootloader/fuses */
  78         MCUSR &= ~(1 << WDRF);
  79         wdt_disable();
  80
  81         /* Disable clock division */
  82         clock_prescale_set(clock_div_1);
  83
  84         /* Hardware Initialization */
  85         Joystick_Init();
  86         LEDs_Init();
  87         USB_Init();
  88 }
  89
  90 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
  91  *  starts the library USB task to begin the enumeration and USB management process.
  92  */
  93 void EVENT_USB_Device_Connect(void)
  94 {
  95         /* Indicate USB enumerating */
  96         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  97
  98         /* Default to report protocol on connect */
  99         UsingReportProtocol = true;
 100 }
 101
 102 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
 103  *  the status LEDs.
 104  */
 105 void EVENT_USB_Device_Disconnect(void)
 106 {
 107         /* Indicate USB not ready */
 108         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 109 }
 110
 111 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration
 112  *  of the USB device after enumeration, and configures the keyboard device endpoints.
 113  */
 114 void EVENT_USB_Device_ConfigurationChanged(void)
 115 {
 116         /* Indicate USB connected and ready */
 117         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 118
 119         /* Setup Keyboard Keycode Report Endpoint */
 120         if (!(Endpoint_ConfigureEndpoint(KEYBOARD_EPNUM, EP_TYPE_INTERRUPT,
 121                                              ENDPOINT_DIR_IN, KEYBOARD_EPSIZE,
 122                                          ENDPOINT_BANK_SINGLE)))
 123         {
 124                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 125         }
 126
 127         /* Setup Keyboard LED Report Endpoint */
 128         if (!(Endpoint_ConfigureEndpoint(KEYBOARD_LEDS_EPNUM, EP_TYPE_INTERRUPT,
 129                                              ENDPOINT_DIR_OUT, KEYBOARD_EPSIZE,
 130                                          ENDPOINT_BANK_SINGLE)))
 131         {
 132                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 133         }
 134
 135         USB_Device_EnableSOFEvents();
 136 }
 137
 138 /** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific
 139  *  control requests that are not handled internally by the USB library (including the HID commands, which are
 140  *  all issued via the control endpoint), so that they can be handled appropriately for the application.
 141  */
 142 void EVENT_USB_Device_UnhandledControlRequest(void)
 143 {
 144         /* Handle HID Class specific requests */
 145         switch (USB_ControlRequest.bRequest)
 146         {
 147                 case REQ_GetReport:
 148                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 149                         {
 150                                 USB_KeyboardReport_Data_t KeyboardReportData;
 151
 152                                 Endpoint_ClearSETUP();
 153
 154                                 /* Create the next keyboard report for transmission to the host */
 155                                 CreateKeyboardReport(&KeyboardReportData);
 156
 157                                 /* Write the report data to the control endpoint */
 158                                 Endpoint_Write_Control_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
 159
 160                                 /* Finalize the stream transfer to send the last packet or clear the host abort */
 161                                 Endpoint_ClearOUT();
 162                         }
 163
 164                         break;
 165                 case REQ_SetReport:
 166                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 167                         {
 168                                 Endpoint_ClearSETUP();
 169
 170                                 /* Wait until the LED report has been sent by the host */
 171                                 while (!(Endpoint_IsOUTReceived()))
 172                                 {
 173                                         if (USB_DeviceState == DEVICE_STATE_Unattached)
 174                                           return;
 175                                 }
 176
 177                                 /* Read in the LED report from the host */
 178                                 uint8_t LEDStatus = Endpoint_Read_Byte();
 179
 180                                 /* Process the incoming LED report */
 181                                 ProcessLEDReport(LEDStatus);
 182
 183                                 /* Clear the endpoint data */
 184                                 Endpoint_ClearOUT();
 185
 186                                 Endpoint_ClearStatusStage();
 187                         }
 188
 189                         break;
 190                 case REQ_GetProtocol:
 191                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 192                         {
 193                                 Endpoint_ClearSETUP();
 194
 195                                 /* Write the current protocol flag to the host */
 196                                 Endpoint_Write_Byte(UsingReportProtocol);
 197
 198                                 /* Send the flag to the host */
 199                                 Endpoint_ClearIN();
 200
 201                                 Endpoint_ClearStatusStage();
 202                         }
 203
 204                         break;
 205                 case REQ_SetProtocol:
 206                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 207                         {
 208                                 Endpoint_ClearSETUP();
 209
 210                                 /* Set or clear the flag depending on what the host indicates that the current Protocol should be */
 211                                 UsingReportProtocol = (USB_ControlRequest.wValue != 0);
 212
 213                                 Endpoint_ClearStatusStage();
 214                         }
 215
 216                         break;
 217                 case REQ_SetIdle:
 218                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 219                         {
 220                                 Endpoint_ClearSETUP();
 221
 222                                 /* Get idle period in MSB, IdleCount must be multiplied by 4 to get number of milliseconds */
 223                                 IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);
 224
 225                                 Endpoint_ClearStatusStage();
 226                         }
 227
 228                         break;
 229                 case REQ_GetIdle:
 230                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 231                         {
 232                                 Endpoint_ClearSETUP();
 233
 234                                 /* Write the current idle duration to the host, must be divided by 4 before sent to host */
 235                                 Endpoint_Write_Byte(IdleCount >> 2);
 236
 237                                 /* Send the flag to the host */
 238                                 Endpoint_ClearIN();
 239
 240                                 Endpoint_ClearStatusStage();
 241                         }
 242
 243                         break;
 244         }
 245 }
 246
 247 /** Event handler for the USB device Start Of Frame event. */
 248 void EVENT_USB_Device_StartOfFrame(void)
 249 {
 250         /* One millisecond has elapsed, decrement the idle time remaining counter if it has not already elapsed */
 251         if (IdleMSRemaining)
 252           IdleMSRemaining--;
 253 }
 254
 255 /** Fills the given HID report data structure with the next HID report to send to the host.
 256  *
 257  *  \param[out] ReportData  Pointer to a HID report data structure to be filled
 258  */
 259 void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData)
 260 {
 261         uint8_t JoyStatus_LCL = Joystick_GetStatus();
 262
 263         /* Clear the report contents */
 264         memset(ReportData, 0, sizeof(USB_KeyboardReport_Data_t));
 265
 266         if (JoyStatus_LCL & JOY_UP)
 267           ReportData->KeyCode[0] = 0x04; // A
 268         else if (JoyStatus_LCL & JOY_DOWN)
 269           ReportData->KeyCode[0] = 0x05; // B
 270
 271         if (JoyStatus_LCL & JOY_LEFT)
 272           ReportData->KeyCode[0] = 0x06; // C
 273         else if (JoyStatus_LCL & JOY_RIGHT)
 274           ReportData->KeyCode[0] = 0x07; // D
 275
 276         if (JoyStatus_LCL & JOY_PRESS)
 277           ReportData->KeyCode[0] = 0x08; // E
 278 }
 279
 280 /** Processes a received LED report, and updates the board LEDs states to match.
 281  *
 282  *  \param[in] LEDReport  LED status report from the host
 283  */
 284 void ProcessLEDReport(uint8_t LEDReport)
 285 {
 286         uint8_t LEDMask = LEDS_LED2;
 287
 288         if (LEDReport & 0x01) // NUM Lock
 289           LEDMask |= LEDS_LED1;
 290
 291         if (LEDReport & 0x02) // CAPS Lock
 292           LEDMask |= LEDS_LED3;
 293
 294         if (LEDReport & 0x04) // SCROLL Lock
 295           LEDMask |= LEDS_LED4;
 296
 297         /* Set the status LEDs to the current Keyboard LED status */
 298         LEDs_SetAllLEDs(LEDMask);
 299 }
 300
 301 /** Sends the next HID report to the host, via the keyboard data endpoint. */
 302 void SendNextReport(void)
 303 {
 304         static USB_KeyboardReport_Data_t PrevKeyboardReportData;
 305         USB_KeyboardReport_Data_t        KeyboardReportData;
 306         bool                             SendReport = true;
 307
 308         /* Create the next keyboard report for transmission to the host */
 309         CreateKeyboardReport(&KeyboardReportData);
 310
 311         /* Check to see if the report data has changed - if so a report MUST be sent */
 312         SendReport = (memcmp(&PrevKeyboardReportData, &KeyboardReportData, sizeof(USB_KeyboardReport_Data_t)) != 0);
 313
 314         /* Save the current report data for later comparison to check for changes */
 315         PrevKeyboardReportData = KeyboardReportData;
 316
 317         /* Check if the idle period is set and has elapsed */
 318         if ((IdleCount != HID_IDLE_CHANGESONLY) && (!(IdleMSRemaining)))
 319         {
 320                 /* Reset the idle time remaining counter */
 321                 IdleMSRemaining = IdleCount;
 322
 323                 /* Idle period is set and has elapsed, must send a report to the host */
 324                 SendReport = true;
 325         }
 326
 327         /* Select the Keyboard Report Endpoint */
 328         Endpoint_SelectEndpoint(KEYBOARD_EPNUM);
 329
 330         /* Check if Keyboard Endpoint Ready for Read/Write and if we should send a new report */
 331         if (Endpoint_IsReadWriteAllowed() && SendReport)
 332         {
 333                 /* Write Keyboard Report Data */
 334                 Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
 335
 336                 /* Finalize the stream transfer to send the last packet */
 337                 Endpoint_ClearIN();
 338         }
 339 }
 340
 341 /** Reads the next LED status report from the host from the LED data endpoint, if one has been sent. */
 342 void ReceiveNextReport(void)
 343 {
 344         /* Select the Keyboard LED Report Endpoint */
 345         Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);
 346
 347         /* Check if Keyboard LED Endpoint contains a packet */
 348         if (Endpoint_IsOUTReceived())
 349         {
 350                 /* Check to see if the packet contains data */
 351                 if (Endpoint_IsReadWriteAllowed())
 352                 {
 353                         /* Read in the LED report from the host */
 354                         uint8_t LEDReport = Endpoint_Read_Byte();
 355
 356                         /* Process the read LED report from the host */
 357                         ProcessLEDReport(LEDReport);
 358                 }
 359
 360                 /* Handshake the OUT Endpoint - clear endpoint and ready for next report */
 361                 Endpoint_ClearOUT();
 362         }
 363 }
 364
 365 /** Function to manage HID report generation and transmission to the host, when in report mode. */
 366 void HID_Task(void)
 367 {
 368         /* Device must be connected and configured for the task to run */
 369         if (USB_DeviceState != DEVICE_STATE_Configured)
 370           return;
 371
 372         /* Send the next keypress report to the host */
 373         SendNextReport();
 374
 375         /* Process the LED report sent from the host */
 376         ReceiveNextReport();
 377 }