Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 KeyboardMouse demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "KeyboardMouse.h"
  38
  39 /** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */
  40 uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];
  41
  42 /** Buffer to hold the previously generated Mouse HID report, for comparison purposes inside the HID class driver. */
  43 uint8_t PrevMouseHIDReportBuffer[sizeof(USB_MouseReport_Data_t)];
  44
  45 /** LUFA HID Class driver interface configuration and state information. This structure is
  46  *  passed to all HID Class driver functions, so that multiple instances of the same class
  47  *  within a device can be differentiated from one another. This is for the keyboard HID
  48  *  interface within the device.
  49  */
  50 USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
  51         {
  52                 .Config =
  53                         {
  54                                 .InterfaceNumber              = 0,
  55
  56                                 .ReportINEndpointNumber       = KEYBOARD_IN_EPNUM,
  57                                 .ReportINEndpointSize         = HID_EPSIZE,
  58                                 .ReportINEndpointDoubleBank   = false,
  59
  60                                 .PrevReportINBuffer           = PrevKeyboardHIDReportBuffer,
  61                                 .PrevReportINBufferSize       = sizeof(PrevKeyboardHIDReportBuffer),
  62                         },
  63         };
  64
  65 /** LUFA HID Class driver interface configuration and state information. This structure is
  66  *  passed to all HID Class driver functions, so that multiple instances of the same class
  67  *  within a device can be differentiated from one another. This is for the mouse HID
  68  *  interface within the device.
  69  */
  70 USB_ClassInfo_HID_Device_t Mouse_HID_Interface =
  71         {
  72                 .Config =
  73                         {
  74                                 .InterfaceNumber              = 1,
  75
  76                                 .ReportINEndpointNumber       = MOUSE_IN_EPNUM,
  77                                 .ReportINEndpointSize         = HID_EPSIZE,
  78
  79                                 .PrevReportINBuffer           = PrevMouseHIDReportBuffer,
  80                                 .PrevReportINBufferSize       = sizeof(PrevMouseHIDReportBuffer),
  81                         },
  82         };
  83
  84 /** Main program entry point. This routine contains the overall program flow, including initial
  85  *  setup of all components and the main program loop.
  86  */
  87 int main(void)
  88 {
  89         SetupHardware();
  90
  91         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  92         sei();
  93
  94         for (;;)
  95         {
  96                 HID_Device_USBTask(&Keyboard_HID_Interface);
  97                 HID_Device_USBTask(&Mouse_HID_Interface);
  98                 USB_USBTask();
  99         }
 100 }
 101
 102 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 103 void SetupHardware()
 104 {
 105         /* Disable watchdog if enabled by bootloader/fuses */
 106         MCUSR &= ~(1 << WDRF);
 107         wdt_disable();
 108
 109         /* Disable clock division */
 110         clock_prescale_set(clock_div_1);
 111
 112         /* Hardware Initialization */
 113         Joystick_Init();
 114         LEDs_Init();
 115         USB_Init();
 116 }
 117
 118 /** Event handler for the library USB Connection event. */
 119 void EVENT_USB_Device_Connect(void)
 120 {
 121     LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 122 }
 123
 124 /** Event handler for the library USB Disconnection event. */
 125 void EVENT_USB_Device_Disconnect(void)
 126 {
 127     LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 128 }
 129
 130 /** Event handler for the library USB Configuration Changed event. */
 131 void EVENT_USB_Device_ConfigurationChanged(void)
 132 {
 133         bool ConfigSuccess = true;
 134
 135         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);
 136         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Mouse_HID_Interface);
 137
 138         USB_Device_EnableSOFEvents();
 139
 140         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 141 }
 142
 143 /** Event handler for the library USB Control Request reception event. */
 144 void EVENT_USB_Device_ControlRequest(void)
 145 {
 146         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 147         HID_Device_ProcessControlRequest(&Mouse_HID_Interface);
 148 }
 149
 150 /** Event handler for the USB device Start Of Frame event. */
 151 void EVENT_USB_Device_StartOfFrame(void)
 152 {
 153         HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 154         HID_Device_MillisecondElapsed(&Mouse_HID_Interface);
 155 }
 156
 157 /** HID class driver callback function for the creation of HID reports to the host.
 158  *
 159  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 160  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 161  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 162  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 163  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 164  *
 165  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 166  */
 167 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 168                                          uint8_t* const ReportID,
 169                                          const uint8_t ReportType,
 170                                          void* ReportData,
 171                                          uint16_t* const ReportSize)
 172 {
 173         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 174         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 175
 176         /* Determine which interface must have its report generated */
 177         if (HIDInterfaceInfo == &Keyboard_HID_Interface)
 178         {
 179                 USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 180
 181                 /* If first board button not being held down, no keyboard report */
 182                 if (!(ButtonStatus_LCL & BUTTONS_BUTTON1))
 183                   return 0;
 184
 185                 KeyboardReport->Modifier = HID_KEYBOARD_MODIFER_LEFTSHIFT;
 186
 187                 if (JoyStatus_LCL & JOY_UP)
 188                   KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_A;
 189                 else if (JoyStatus_LCL & JOY_DOWN)
 190                   KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_B;
 191
 192                 if (JoyStatus_LCL & JOY_LEFT)
 193                   KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_C;
 194                 else if (JoyStatus_LCL & JOY_RIGHT)
 195                   KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_D;
 196
 197                 if (JoyStatus_LCL & JOY_PRESS)
 198                   KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_E;
 199
 200                 *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 201                 return false;
 202         }
 203         else
 204         {
 205                 USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
 206
 207                 /* If first board button being held down, no mouse report */
 208                 if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 209                   return 0;
 210
 211                 if (JoyStatus_LCL & JOY_UP)
 212                   MouseReport->Y = -1;
 213                 else if (JoyStatus_LCL & JOY_DOWN)
 214                   MouseReport->Y =  1;
 215
 216                 if (JoyStatus_LCL & JOY_LEFT)
 217                   MouseReport->X = -1;
 218                 else if (JoyStatus_LCL & JOY_RIGHT)
 219                   MouseReport->X =  1;
 220
 221                 if (JoyStatus_LCL & JOY_PRESS)
 222                   MouseReport->Button |= (1 << 0);
 223
 224                 *ReportSize = sizeof(USB_MouseReport_Data_t);
 225                 return true;
 226         }
 227 }
 228
 229 /** HID class driver callback function for the processing of HID reports from the host.
 230  *
 231  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 232  *  \param[in] ReportID    Report ID of the received report from the host
 233  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 234  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 235  *  \param[in] ReportSize  Size in bytes of the received HID report
 236  */
 237 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 238                                           const uint8_t ReportID,
 239                                           const uint8_t ReportType,
 240                                           const void* ReportData,
 241                                           const uint16_t ReportSize)
 242 {
 243         if (HIDInterfaceInfo == &Keyboard_HID_Interface)
 244         {
 245                 uint8_t  LEDMask   = LEDS_NO_LEDS;
 246                 uint8_t* LEDReport = (uint8_t*)ReportData;
 247
 248                 if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
 249                   LEDMask |= LEDS_LED1;
 250
 251                 if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
 252                   LEDMask |= LEDS_LED3;
 253
 254                 if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
 255                   LEDMask |= LEDS_LED4;
 256
 257                 LEDs_SetAllLEDs(LEDMask);
 258         }
 259 }