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 /** LUFA HID Class driver interface configuration and state information. This structure is
  41  *  passed to all HID Class driver functions, so that multiple instances of the same class
  42  *  within a device can be differentiated from one another. This is for the keyboard HID
  43  *  interface within the device.
  44  */
  45 USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
  46         {
  47                 .Config =
  48                         {
  49                                 .InterfaceNumber         = 0,
  50
  51                                 .ReportINEndpointNumber  = KEYBOARD_IN_EPNUM,
  52                                 .ReportINEndpointSize    = HID_EPSIZE,
  53                         },
  54         };
  55
  56 /** LUFA HID Class driver interface configuration and state information. This structure is
  57  *  passed to all HID Class driver functions, so that multiple instances of the same class
  58  *  within a device can be differentiated from one another. This is for the mouse HID
  59  *  interface within the device.
  60  */
  61 USB_ClassInfo_HID_Device_t Mouse_HID_Interface =
  62         {
  63                 .Config =
  64                         {
  65                                 .InterfaceNumber         = 0,
  66
  67                                 .ReportINEndpointNumber  = MOUSE_IN_EPNUM,
  68                                 .ReportINEndpointSize    = HID_EPSIZE,
  69                         },
  70
  71                 .State =
  72                         {
  73                                 // Leave all state values to their defaults
  74                         }
  75         };
  76
  77 /** Main program entry point. This routine contains the overall program flow, including initial
  78  *  setup of all components and the main program loop.
  79  */
  80 int main(void)
  81 {
  82         SetupHardware();
  83
  84         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  85
  86         for (;;)
  87         {
  88                 HID_Device_USBTask(&Keyboard_HID_Interface);
  89                 HID_Device_USBTask(&Mouse_HID_Interface);
  90                 USB_USBTask();
  91         }
  92 }
  93
  94 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  95 void SetupHardware()
  96 {
  97         /* Disable watchdog if enabled by bootloader/fuses */
  98         MCUSR &= ~(1 << WDRF);
  99         wdt_disable();
 100
 101         /* Disable clock division */
 102         clock_prescale_set(clock_div_1);
 103
 104         /* Hardware Initialization */
 105         Joystick_Init();
 106         LEDs_Init();
 107         USB_Init();
 108
 109         /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */
 110         OCR0A  = ((F_CPU / 64) / 1000);
 111         TCCR0A = (1 << WGM01);
 112         TCCR0B = ((1 << CS01) | (1 << CS00));
 113         TIMSK0 = (1 << OCIE0A);
 114 }
 115
 116 /** Event handler for the library USB Connection event. */
 117 void EVENT_USB_Connect(void)
 118 {
 119     LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 120 }
 121
 122 /** Event handler for the library USB Disconnection event. */
 123 void EVENT_USB_Disconnect(void)
 124 {
 125     LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 126 }
 127
 128 /** Event handler for the library USB Configuration Changed event. */
 129 void EVENT_USB_ConfigurationChanged(void)
 130 {
 131         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 132
 133         if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))
 134           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 135
 136         if (!(HID_Device_ConfigureEndpoints(&Mouse_HID_Interface)))
 137           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 138 }
 139
 140 /** Event handler for the library USB Unhandled Control Packet event. */
 141 void EVENT_USB_UnhandledControlPacket(void)
 142 {
 143         HID_Device_ProcessControlPacket(&Keyboard_HID_Interface);
 144         HID_Device_ProcessControlPacket(&Mouse_HID_Interface);
 145 }
 146
 147 /** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */
 148 ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 149 {
 150         if (Keyboard_HID_Interface.State.IdleMSRemaining)
 151           Keyboard_HID_Interface.State.IdleMSRemaining--;
 152
 153         if (Mouse_HID_Interface.State.IdleMSRemaining)
 154           Mouse_HID_Interface.State.IdleMSRemaining--;
 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  *
 163  *  \return Number of bytes written in the report (or zero if no report is to be sent
 164  */
 165 uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID, void* ReportData)
 166 {
 167         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 168         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 169
 170         if (HIDInterfaceInfo == &Keyboard_HID_Interface)
 171         {
 172                 USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 173
 174                 /* If first board button not being held down, no keyboard report */
 175                 if (!(ButtonStatus_LCL & BUTTONS_BUTTON1))
 176                   return 0;
 177
 178                 if (JoyStatus_LCL & JOY_UP)
 179                   KeyboardReport->KeyCode[0] = 0x04; // A
 180                 else if (JoyStatus_LCL & JOY_DOWN)
 181                   KeyboardReport->KeyCode[0] = 0x05; // B
 182
 183                 if (JoyStatus_LCL & JOY_LEFT)
 184                   KeyboardReport->KeyCode[0] = 0x06; // C
 185                 else if (JoyStatus_LCL & JOY_RIGHT)
 186                   KeyboardReport->KeyCode[0] = 0x07; // D
 187
 188                 if (JoyStatus_LCL & JOY_PRESS)
 189                   KeyboardReport->KeyCode[0] = 0x08; // E
 190
 191                 return sizeof(USB_KeyboardReport_Data_t);
 192         }
 193         else
 194         {
 195                 USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
 196
 197                 /* If first board button being held down, no mouse report */
 198                 if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 199                   return 0;
 200
 201                 if (JoyStatus_LCL & JOY_UP)
 202                   MouseReport->Y = -1;
 203                 else if (JoyStatus_LCL & JOY_DOWN)
 204                   MouseReport->Y =  1;
 205
 206                 if (JoyStatus_LCL & JOY_RIGHT)
 207                   MouseReport->X =  1;
 208                 else if (JoyStatus_LCL & JOY_LEFT)
 209                   MouseReport->X = -1;
 210
 211                 if (JoyStatus_LCL & JOY_PRESS)
 212                   MouseReport->Button  = (1 << 0);
 213
 214                 return sizeof(USB_MouseReport_Data_t);
 215         }
 216 }
 217
 218 /** HID class driver callback function for the processing of HID reports from the host.
 219  *
 220  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 221  *  \param[in] ReportID  Report ID of the received report from the host
 222  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 223  *  \param[in] ReportSize  Size in bytes of the received HID report
 224  */
 225 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 226                                           const void* ReportData, const uint16_t ReportSize)
 227 {
 228         if (HIDInterfaceInfo == &Keyboard_HID_Interface)
 229         {
 230                 uint8_t  LEDMask   = LEDS_NO_LEDS;
 231                 uint8_t* LEDReport = (uint8_t*)ReportData;
 232
 233                 if (*LEDReport & 0x01) // NUM Lock
 234                   LEDMask |= LEDS_LED1;
 235
 236                 if (*LEDReport & 0x02) // CAPS Lock
 237                   LEDMask |= LEDS_LED3;
 238
 239                 if (*LEDReport & 0x04) // SCROLL Lock
 240                   LEDMask |= LEDS_LED4;
 241
 242                 LEDs_SetAllLEDs(LEDMask);
 243         }
 244 }