Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
  12
  13   Permission to use, copy, modify, distribute, and sell this
  14   software and its documentation for any purpose is hereby granted
  15   without fee, provided that the above copyright notice appear in
  16   all 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 KeyboardMouse demo. This file contains the main tasks of the demo and
  35  *  is responsible for the initial application hardware configuration.
  36  */
  37
  38 #include "KeyboardMouse.h"
  39
  40 /** Global structure to hold the current keyboard interface HID report, for transmission to the host */
  41 USB_KeyboardReport_Data_t KeyboardReportData;
  42
  43 /** Global structure to hold the current mouse interface HID report, for transmission to the host */
  44 USB_MouseReport_Data_t    MouseReportData;
  45
  46
  47 /** Main program entry point. This routine configures the hardware required by the application, then
  48  *  enters a loop to run the application tasks in sequence.
  49  */
  50 int main(void)
  51 {
  52         SetupHardware();
  53
  54         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  55         sei();
  56
  57         for (;;)
  58         {
  59                 Keyboard_HID_Task();
  60                 Mouse_HID_Task();
  61                 USB_USBTask();
  62         }
  63 }
  64
  65 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  66 void SetupHardware(void)
  67 {
  68         /* Disable watchdog if enabled by bootloader/fuses */
  69         MCUSR &= ~(1 << WDRF);
  70         wdt_disable();
  71
  72         /* Disable clock division */
  73         clock_prescale_set(clock_div_1);
  74
  75         /* Hardware Initialization */
  76         Joystick_Init();
  77         LEDs_Init();
  78         USB_Init();
  79 }
  80
  81 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
  82  *  starts the library USB task to begin the enumeration and USB management process.
  83  */
  84 void EVENT_USB_Device_Connect(void)
  85 {
  86         /* Indicate USB enumerating */
  87         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  88 }
  89
  90 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
  91  *  the status LEDs and stops the USB management task.
  92  */
  93 void EVENT_USB_Device_Disconnect(void)
  94 {
  95         /* Indicate USB not ready */
  96         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  97 }
  98
  99 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration
 100  *  of the USB device after enumeration, and configures the keyboard and mouse device endpoints.
 101  */
 102 void EVENT_USB_Device_ConfigurationChanged(void)
 103 {
 104         bool ConfigSuccess = true;
 105
 106         /* Setup Keyboard HID Report Endpoints */
 107         ConfigSuccess &= Endpoint_ConfigureEndpoint(KEYBOARD_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
 108                                                     HID_EPSIZE, ENDPOINT_BANK_SINGLE);
 109         ConfigSuccess &= Endpoint_ConfigureEndpoint(KEYBOARD_OUT_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_OUT,
 110                                                     HID_EPSIZE, ENDPOINT_BANK_SINGLE);
 111
 112         /* Setup Mouse HID Report Endpoint */
 113         ConfigSuccess &= Endpoint_ConfigureEndpoint(MOUSE_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
 114                                                     HID_EPSIZE, ENDPOINT_BANK_SINGLE);
 115
 116         /* Indicate endpoint configuration success or failure */
 117         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 118 }
 119
 120 /** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific
 121  *  control requests that are not handled internally by the USB library (including the HID commands, which are
 122  *  all issued via the control endpoint), so that they can be handled appropriately for the application.
 123  */
 124 void EVENT_USB_Device_UnhandledControlRequest(void)
 125 {
 126         uint8_t* ReportData;
 127         uint8_t  ReportSize;
 128
 129         /* Handle HID Class specific requests */
 130         switch (USB_ControlRequest.bRequest)
 131         {
 132                 case REQ_GetReport:
 133                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 134                         {
 135                                 Endpoint_ClearSETUP();
 136
 137                                 /* Determine if it is the mouse or the keyboard data that is being requested */
 138                                 if (!(USB_ControlRequest.wIndex))
 139                                 {
 140                                         ReportData = (uint8_t*)&KeyboardReportData;
 141                                         ReportSize = sizeof(KeyboardReportData);
 142                                 }
 143                                 else
 144                                 {
 145                                         ReportData = (uint8_t*)&MouseReportData;
 146                                         ReportSize = sizeof(MouseReportData);
 147                                 }
 148
 149                                 /* Write the report data to the control endpoint */
 150                                 Endpoint_Write_Control_Stream_LE(ReportData, ReportSize);
 151                                 Endpoint_ClearOUT();
 152
 153                                 /* Clear the report data afterwards */
 154                                 memset(ReportData, 0, ReportSize);
 155                         }
 156
 157                         break;
 158                 case REQ_SetReport:
 159                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 160                         {
 161                                 Endpoint_ClearSETUP();
 162
 163                                 /* Wait until the LED report has been sent by the host */
 164                                 while (!(Endpoint_IsOUTReceived()))
 165                                 {
 166                                         if (USB_DeviceState == DEVICE_STATE_Unattached)
 167                                           return;
 168                                 }
 169
 170                                 /* Read in the LED report from the host */
 171                                 uint8_t LEDStatus = Endpoint_Read_Byte();
 172
 173                                 Endpoint_ClearOUT();
 174                                 Endpoint_ClearStatusStage();
 175
 176                                 /* Process the incoming LED report */
 177                                 Keyboard_ProcessLEDReport(LEDStatus);
 178                         }
 179
 180                         break;
 181         }
 182 }
 183
 184 /** Processes a given Keyboard LED report from the host, and sets the board LEDs to match. Since the Keyboard
 185  *  LED report can be sent through either the control endpoint (via a HID SetReport request) or the HID OUT
 186  *  endpoint, the processing code is placed here to avoid duplicating it and potentially having different
 187  *  behaviour depending on the method used to sent it.
 188  */
 189 void Keyboard_ProcessLEDReport(const uint8_t LEDStatus)
 190 {
 191         uint8_t LEDMask = LEDS_LED2;
 192
 193         if (LEDStatus & KEYBOARD_LED_NUMLOCK)
 194           LEDMask |= LEDS_LED1;
 195
 196         if (LEDStatus & KEYBOARD_LED_CAPSLOCK)
 197           LEDMask |= LEDS_LED3;
 198
 199         if (LEDStatus & KEYBOARD_LED_SCROLLLOCK)
 200           LEDMask |= LEDS_LED4;
 201
 202         /* Set the status LEDs to the current Keyboard LED status */
 203         LEDs_SetAllLEDs(LEDMask);
 204 }
 205
 206 /** Keyboard task. This generates the next keyboard HID report for the host, and transmits it via the
 207  *  keyboard IN endpoint when the host is ready for more data. Additionally, it processes host LED status
 208  *  reports sent to the device via the keyboard OUT reporting endpoint.
 209  */
 210 void Keyboard_HID_Task(void)
 211 {
 212         uint8_t JoyStatus_LCL = Joystick_GetStatus();
 213
 214         /* Device must be connected and configured for the task to run */
 215         if (USB_DeviceState != DEVICE_STATE_Configured)
 216           return;
 217
 218         /* Check if board button is not pressed, if so mouse mode enabled */
 219         if (!(Buttons_GetStatus() & BUTTONS_BUTTON1))
 220         {
 221                 /* Make sent key uppercase by indicating that the left shift key is pressed */
 222                 KeyboardReportData.Modifier = KEYBOARD_MODIFER_LEFTSHIFT;
 223
 224                 if (JoyStatus_LCL & JOY_UP)
 225                   KeyboardReportData.KeyCode[0] = 0x04; // A
 226                 else if (JoyStatus_LCL & JOY_DOWN)
 227                   KeyboardReportData.KeyCode[0] = 0x05; // B
 228
 229                 if (JoyStatus_LCL & JOY_LEFT)
 230                   KeyboardReportData.KeyCode[0] = 0x06; // C
 231                 else if (JoyStatus_LCL & JOY_RIGHT)
 232                   KeyboardReportData.KeyCode[0] = 0x07; // D
 233
 234                 if (JoyStatus_LCL & JOY_PRESS)
 235                   KeyboardReportData.KeyCode[0] = 0x08; // E
 236         }
 237
 238         /* Select the Keyboard Report Endpoint */
 239         Endpoint_SelectEndpoint(KEYBOARD_IN_EPNUM);
 240
 241         /* Check if Keyboard Endpoint Ready for Read/Write */
 242         if (Endpoint_IsReadWriteAllowed())
 243         {
 244                 /* Write Keyboard Report Data */
 245                 Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
 246
 247                 /* Finalize the stream transfer to send the last packet */
 248                 Endpoint_ClearIN();
 249
 250                 /* Clear the report data afterwards */
 251                 memset(&KeyboardReportData, 0, sizeof(KeyboardReportData));
 252         }
 253
 254         /* Select the Keyboard LED Report Endpoint */
 255         Endpoint_SelectEndpoint(KEYBOARD_OUT_EPNUM);
 256
 257         /* Check if Keyboard LED Endpoint Ready for Read/Write */
 258         if (Endpoint_IsReadWriteAllowed())
 259         {
 260                 /* Read in and process the LED report from the host */
 261                 Keyboard_ProcessLEDReport(Endpoint_Read_Byte());
 262
 263                 /* Handshake the OUT Endpoint - clear endpoint and ready for next report */
 264                 Endpoint_ClearOUT();
 265         }
 266 }
 267
 268 /** Mouse task. This generates the next mouse HID report for the host, and transmits it via the
 269  *  mouse IN endpoint when the host is ready for more data.
 270  */
 271 void Mouse_HID_Task(void)
 272 {
 273         uint8_t JoyStatus_LCL = Joystick_GetStatus();
 274
 275         /* Device must be connected and configured for the task to run */
 276         if (USB_DeviceState != DEVICE_STATE_Configured)
 277           return;
 278
 279         /* Check if board button is pressed, if so mouse mode enabled */
 280         if (Buttons_GetStatus() & BUTTONS_BUTTON1)
 281         {
 282                 if (JoyStatus_LCL & JOY_UP)
 283                   MouseReportData.Y =  1;
 284                 else if (JoyStatus_LCL & JOY_DOWN)
 285                   MouseReportData.Y = -1;
 286
 287                 if (JoyStatus_LCL & JOY_RIGHT)
 288                   MouseReportData.X =  1;
 289                 else if (JoyStatus_LCL & JOY_LEFT)
 290                   MouseReportData.X = -1;
 291
 292                 if (JoyStatus_LCL & JOY_PRESS)
 293                   MouseReportData.Button  = (1 << 0);
 294         }
 295
 296         /* Select the Mouse Report Endpoint */
 297         Endpoint_SelectEndpoint(MOUSE_IN_EPNUM);
 298
 299         /* Check if Mouse Endpoint Ready for Read/Write */
 300         if (Endpoint_IsReadWriteAllowed())
 301         {
 302                 /* Write Mouse Report Data */
 303                 Endpoint_Write_Stream_LE(&MouseReportData, sizeof(MouseReportData));
 304
 305                 /* Finalize the stream transfer to send the last packet */
 306                 Endpoint_ClearIN();
 307
 308                 /* Clear the report data afterwards */
 309                 memset(&MouseReportData, 0, sizeof(MouseReportData));
 310         }
 311 }
 312