Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.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   Copyright 2009  Denver Gingerich (denver [at] ossguy [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 KeyboardMouse demo. This file contains the main tasks of
  35  *  the demo and is responsible for the initial application hardware configuration.
  36  */
  37
  38 #include "KeyboardMouse.h"
  39
  40 /** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */
  41 uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];
  42
  43 /** Buffer to hold the previously generated Mouse HID report, for comparison purposes inside the HID class driver. */
  44 uint8_t PrevMouseHIDReportBuffer[sizeof(USB_MouseReport_Data_t)];
  45
  46 /** LUFA HID Class driver interface configuration and state information. This structure is
  47  *  passed to all HID Class driver functions, so that multiple instances of the same class
  48  *  within a device can be differentiated from one another. This is for the keyboard HID
  49  *  interface within the device.
  50  */
  51 USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
  52         {
  53                 .Config =
  54                         {
  55                                 .InterfaceNumber         = 0,
  56
  57                                 .ReportINEndpointNumber  = KEYBOARD_IN_EPNUM,
  58                                 .ReportINEndpointSize    = HID_EPSIZE,
  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         = 0,
  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
  93         for (;;)
  94         {
  95                 HID_Device_USBTask(&Keyboard_HID_Interface);
  96                 HID_Device_USBTask(&Mouse_HID_Interface);
  97                 USB_USBTask();
  98         }
  99 }
 100
 101 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 102 void SetupHardware()
 103 {
 104         /* Disable watchdog if enabled by bootloader/fuses */
 105         MCUSR &= ~(1 << WDRF);
 106         wdt_disable();
 107
 108         /* Disable clock division */
 109         clock_prescale_set(clock_div_1);
 110
 111         /* Hardware Initialization */
 112         Joystick_Init();
 113         LEDs_Init();
 114         USB_Init();
 115 }
 116
 117 /** Event handler for the library USB Connection event. */
 118 void EVENT_USB_Device_Connect(void)
 119 {
 120     LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 121 }
 122
 123 /** Event handler for the library USB Disconnection event. */
 124 void EVENT_USB_Device_Disconnect(void)
 125 {
 126     LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 127 }
 128
 129 /** Event handler for the library USB Configuration Changed event. */
 130 void EVENT_USB_Device_ConfigurationChanged(void)
 131 {
 132         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 133
 134         if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))
 135           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 136
 137         if (!(HID_Device_ConfigureEndpoints(&Mouse_HID_Interface)))
 138           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 139
 140         USB_Device_EnableSOFEvents();
 141 }
 142
 143 /** Event handler for the library USB Unhandled Control Request event. */
 144 void EVENT_USB_Device_UnhandledControlRequest(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[out] ReportData  Pointer to a buffer where the created report should be stored
 162  *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 163  *
 164  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 165  */
 166 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 167                                          void* ReportData, uint16_t* ReportSize)
 168 {
 169         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 170         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 171
 172         if (HIDInterfaceInfo == &Keyboard_HID_Interface)
 173         {
 174                 USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 175
 176                 /* If first board button not being held down, no keyboard report */
 177                 if (!(ButtonStatus_LCL & BUTTONS_BUTTON1))
 178                   return 0;
 179
 180                 if (JoyStatus_LCL & JOY_UP)
 181                   KeyboardReport->KeyCode[0] = 0x04; // A
 182                 else if (JoyStatus_LCL & JOY_DOWN)
 183                   KeyboardReport->KeyCode[0] = 0x05; // B
 184
 185                 if (JoyStatus_LCL & JOY_LEFT)
 186                   KeyboardReport->KeyCode[0] = 0x06; // C
 187                 else if (JoyStatus_LCL & JOY_RIGHT)
 188                   KeyboardReport->KeyCode[0] = 0x07; // D
 189
 190                 if (JoyStatus_LCL & JOY_PRESS)
 191                   KeyboardReport->KeyCode[0] = 0x08; // E
 192
 193                 *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 194                 return false;
 195         }
 196         else
 197         {
 198                 USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
 199
 200                 /* If first board button being held down, no mouse report */
 201                 if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 202                   return 0;
 203
 204                 if (JoyStatus_LCL & JOY_UP)
 205                   MouseReport->Y = -1;
 206                 else if (JoyStatus_LCL & JOY_DOWN)
 207                   MouseReport->Y =  1;
 208
 209                 if (JoyStatus_LCL & JOY_RIGHT)
 210                   MouseReport->X =  1;
 211                 else if (JoyStatus_LCL & JOY_LEFT)
 212                   MouseReport->X = -1;
 213
 214                 if (JoyStatus_LCL & JOY_PRESS)
 215                   MouseReport->Button  = (1 << 0);
 216
 217                 *ReportSize = sizeof(USB_MouseReport_Data_t);
 218                 return true;
 219         }
 220 }
 221
 222 /** HID class driver callback function for the processing of HID reports from the host.
 223  *
 224  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 225  *  \param[in] ReportID  Report ID of the received report from the host
 226  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 227  *  \param[in] ReportSize  Size in bytes of the received HID report
 228  */
 229 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 230                                           const void* ReportData, const uint16_t ReportSize)
 231 {
 232         if (HIDInterfaceInfo == &Keyboard_HID_Interface)
 233         {
 234                 uint8_t  LEDMask   = LEDS_NO_LEDS;
 235                 uint8_t* LEDReport = (uint8_t*)ReportData;
 236
 237                 if (*LEDReport & 0x01) // NUM Lock
 238                   LEDMask |= LEDS_LED1;
 239
 240                 if (*LEDReport & 0x02) // CAPS Lock
 241                   LEDMask |= LEDS_LED3;
 242
 243                 if (*LEDReport & 0x04) // SCROLL Lock
 244                   LEDMask |= LEDS_LED4;
 245
 246                 LEDs_SetAllLEDs(LEDMask);
 247         }
 248 }