Demos/Device/ClassDriver/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
  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
  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[in] ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_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, uint8_t* const ReportID,
 168                                          const uint8_t ReportType, void* ReportData, uint16_t* ReportSize)
 169 {
 170         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 171         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 172
 173         /* Determine which interface must have its report generated */
 174         if (HIDInterfaceInfo == &Keyboard_HID_Interface)
 175         {
 176                 USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 177
 178                 /* If first board button not being held down, no keyboard report */
 179                 if (!(ButtonStatus_LCL & BUTTONS_BUTTON1))
 180                   return 0;
 181
 182                 KeyboardReport->Modifier = HID_KEYBOARD_MODIFER_LEFTSHIFT;
 183
 184                 if (JoyStatus_LCL & JOY_UP)
 185                   KeyboardReport->KeyCode[0] = 0x04; // A
 186                 else if (JoyStatus_LCL & JOY_DOWN)
 187                   KeyboardReport->KeyCode[0] = 0x05; // B
 188
 189                 if (JoyStatus_LCL & JOY_LEFT)
 190                   KeyboardReport->KeyCode[0] = 0x06; // C
 191                 else if (JoyStatus_LCL & JOY_RIGHT)
 192                   KeyboardReport->KeyCode[0] = 0x07; // D
 193
 194                 if (JoyStatus_LCL & JOY_PRESS)
 195                   KeyboardReport->KeyCode[0] = 0x08; // E
 196
 197                 *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 198                 return false;
 199         }
 200         else
 201         {
 202                 USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
 203
 204                 /* If first board button being held down, no mouse report */
 205                 if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 206                   return 0;
 207
 208                 if (JoyStatus_LCL & JOY_UP)
 209                   MouseReport->Y = -1;
 210                 else if (JoyStatus_LCL & JOY_DOWN)
 211                   MouseReport->Y =  1;
 212
 213                 if (JoyStatus_LCL & JOY_LEFT)
 214                   MouseReport->X = -1;
 215                 else if (JoyStatus_LCL & JOY_RIGHT)
 216                   MouseReport->X =  1;
 217
 218                 if (JoyStatus_LCL & JOY_PRESS)
 219                   MouseReport->Button |= (1 << 0);
 220
 221                 *ReportSize = sizeof(USB_MouseReport_Data_t);
 222                 return true;
 223         }
 224 }
 225
 226 /** HID class driver callback function for the processing of HID reports from the host.
 227  *
 228  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 229  *  \param[in] ReportID  Report ID of the received report from the host
 230  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 231  *  \param[in] ReportSize  Size in bytes of the received HID report
 232  */
 233 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 234                                           const void* ReportData, const uint16_t ReportSize)
 235 {
 236         if (HIDInterfaceInfo == &Keyboard_HID_Interface)
 237         {
 238                 uint8_t  LEDMask   = LEDS_NO_LEDS;
 239                 uint8_t* LEDReport = (uint8_t*)ReportData;
 240
 241                 if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
 242                   LEDMask |= LEDS_LED1;
 243
 244                 if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
 245                   LEDMask |= LEDS_LED3;
 246
 247                 if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
 248                   LEDMask |= LEDS_LED4;
 249
 250                 LEDs_SetAllLEDs(LEDMask);
 251         }
 252 }