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         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         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 134
 135         if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))
 136           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 137
 138         if (!(HID_Device_ConfigureEndpoints(&Mouse_HID_Interface)))
 139           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 140
 141         USB_Device_EnableSOFEvents();
 142 }
 143
 144 /** Event handler for the library USB Unhandled Control Request event. */
 145 void EVENT_USB_Device_UnhandledControlRequest(void)
 146 {
 147         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 148         HID_Device_ProcessControlRequest(&Mouse_HID_Interface);
 149 }
 150
 151 /** Event handler for the USB device Start Of Frame event. */
 152 void EVENT_USB_Device_StartOfFrame(void)
 153 {
 154         HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 155         HID_Device_MillisecondElapsed(&Mouse_HID_Interface);
 156 }
 157
 158 /** HID class driver callback function for the creation of HID reports to the host.
 159  *
 160  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 161  *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 162  *  \param[in]     ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
 163  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 164  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 165  *
 166  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 167  */
 168 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 169                                          const uint8_t ReportType, void* ReportData, uint16_t* const ReportSize)
 170 {
 171         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 172         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 173
 174         /* Determine which interface must have its report generated */
 175         if (HIDInterfaceInfo == &Keyboard_HID_Interface)
 176         {
 177                 USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 178
 179                 /* If first board button not being held down, no keyboard report */
 180                 if (!(ButtonStatus_LCL & BUTTONS_BUTTON1))
 181                   return 0;
 182
 183                 KeyboardReport->Modifier = HID_KEYBOARD_MODIFER_LEFTSHIFT;
 184
 185                 if (JoyStatus_LCL & JOY_UP)
 186                   KeyboardReport->KeyCode[0] = 0x04; // A
 187                 else if (JoyStatus_LCL & JOY_DOWN)
 188                   KeyboardReport->KeyCode[0] = 0x05; // B
 189
 190                 if (JoyStatus_LCL & JOY_LEFT)
 191                   KeyboardReport->KeyCode[0] = 0x06; // C
 192                 else if (JoyStatus_LCL & JOY_RIGHT)
 193                   KeyboardReport->KeyCode[0] = 0x07; // D
 194
 195                 if (JoyStatus_LCL & JOY_PRESS)
 196                   KeyboardReport->KeyCode[0] = 0x08; // E
 197
 198                 *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 199                 return false;
 200         }
 201         else
 202         {
 203                 USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
 204
 205                 /* If first board button being held down, no mouse report */
 206                 if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 207                   return 0;
 208
 209                 if (JoyStatus_LCL & JOY_UP)
 210                   MouseReport->Y = -1;
 211                 else if (JoyStatus_LCL & JOY_DOWN)
 212                   MouseReport->Y =  1;
 213
 214                 if (JoyStatus_LCL & JOY_LEFT)
 215                   MouseReport->X = -1;
 216                 else if (JoyStatus_LCL & JOY_RIGHT)
 217                   MouseReport->X =  1;
 218
 219                 if (JoyStatus_LCL & JOY_PRESS)
 220                   MouseReport->Button |= (1 << 0);
 221
 222                 *ReportSize = sizeof(USB_MouseReport_Data_t);
 223                 return true;
 224         }
 225 }
 226
 227 /** HID class driver callback function for the processing of HID reports from the host.
 228  *
 229  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 230  *  \param[in] ReportID    Report ID of the received report from the host
 231  *  \param[in] ReportType  The type of report that the host has sent, either REPORT_ITEM_TYPE_Out or REPORT_ITEM_TYPE_Feature
 232  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 233  *  \param[in] ReportSize  Size in bytes of the received HID report
 234  */
 235 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 236                                           const uint8_t ReportType, const void* ReportData, const uint16_t ReportSize)
 237 {
 238         if (HIDInterfaceInfo == &Keyboard_HID_Interface)
 239         {
 240                 uint8_t  LEDMask   = LEDS_NO_LEDS;
 241                 uint8_t* LEDReport = (uint8_t*)ReportData;
 242
 243                 if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
 244                   LEDMask |= LEDS_LED1;
 245
 246                 if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
 247                   LEDMask |= LEDS_LED3;
 248
 249                 if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
 250                   LEDMask |= LEDS_LED4;
 251
 252                 LEDs_SetAllLEDs(LEDMask);
 253         }
 254 }