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