Demos/Device/ClassDriver/Mouse/Mouse.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 Mouse demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "Mouse.h"
  38
  39 /** Buffer to hold the previously generated Mouse HID report, for comparison purposes inside the HID class driver. */
  40 uint8_t PrevMouseHIDReportBuffer[sizeof(USB_MouseReport_Data_t)];
  41
  42 /** LUFA HID Class driver interface configuration and state information. This structure is
  43  *  passed to all HID Class driver functions, so that multiple instances of the same class
  44  *  within a device can be differentiated from one another.
  45  */
  46 USB_ClassInfo_HID_Device_t Mouse_HID_Interface =
  47         {
  48                 .Config =
  49                         {
  50                                 .InterfaceNumber              = 0,
  51
  52                                 .ReportINEndpointNumber       = MOUSE_EPNUM,
  53                                 .ReportINEndpointSize         = MOUSE_EPSIZE,
  54                                 .ReportINEndpointDoubleBank   = false,
  55
  56                                 .PrevReportINBuffer           = PrevMouseHIDReportBuffer,
  57                                 .PrevReportINBufferSize       = sizeof(PrevMouseHIDReportBuffer),
  58                         },
  59         };
  60
  61 /** Main program entry point. This routine contains the overall program flow, including initial
  62  *  setup of all components and the main program loop.
  63  */
  64 int main(void)
  65 {
  66         SetupHardware();
  67
  68         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  69
  70         for (;;)
  71         {
  72                 HID_Device_USBTask(&Mouse_HID_Interface);
  73                 USB_USBTask();
  74         }
  75 }
  76
  77 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  78 void SetupHardware(void)
  79 {
  80         /* Disable watchdog if enabled by bootloader/fuses */
  81         MCUSR &= ~(1 << WDRF);
  82         wdt_disable();
  83
  84         /* Disable clock division */
  85         clock_prescale_set(clock_div_1);
  86
  87         /* Hardware Initialization */
  88         Joystick_Init();
  89         LEDs_Init();
  90         Buttons_Init();
  91         USB_Init();
  92 }
  93
  94 /** Event handler for the library USB WakeUp event. */
  95 void EVENT_USB_Device_Connect(void)
  96 {
  97         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  98 }
  99
 100 /** Event handler for the library USB Suspend event. */
 101 void EVENT_USB_Device_Disconnect(void)
 102 {
 103         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 104 }
 105
 106 /** Event handler for the library USB Configuration Changed event. */
 107 void EVENT_USB_Device_ConfigurationChanged(void)
 108 {
 109         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 110
 111         if (!(HID_Device_ConfigureEndpoints(&Mouse_HID_Interface)))
 112           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 113
 114         USB_Device_EnableSOFEvents();
 115 }
 116
 117 /** Event handler for the library USB Unhandled Control Request event. */
 118 void EVENT_USB_Device_UnhandledControlRequest(void)
 119 {
 120         HID_Device_ProcessControlRequest(&Mouse_HID_Interface);
 121 }
 122
 123 /** Event handler for the USB device Start Of Frame event. */
 124 void EVENT_USB_Device_StartOfFrame(void)
 125 {
 126         HID_Device_MillisecondElapsed(&Mouse_HID_Interface);
 127 }
 128
 129 /** HID class driver callback function for the creation of HID reports to the host.
 130  *
 131  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 132  *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 133  *  \param[in] ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
 134  *  \param[out] ReportData  Pointer to a buffer where the created report should be stored
 135  *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 136  *
 137  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 138  */
 139 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 140                                          const uint8_t ReportType, void* ReportData, uint16_t* ReportSize)
 141 {
 142         USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
 143
 144         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 145         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 146
 147         if (JoyStatus_LCL & JOY_UP)
 148           MouseReport->Y = -1;
 149         else if (JoyStatus_LCL & JOY_DOWN)
 150           MouseReport->Y =  1;
 151
 152         if (JoyStatus_LCL & JOY_LEFT)
 153           MouseReport->X = -1;
 154         else if (JoyStatus_LCL & JOY_RIGHT)
 155           MouseReport->X =  1;
 156
 157         if (JoyStatus_LCL & JOY_PRESS)
 158           MouseReport->Button  = (1 << 0);
 159
 160         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 161           MouseReport->Button |= (1 << 1);
 162
 163         *ReportSize = sizeof(USB_MouseReport_Data_t);
 164         return true;
 165 }
 166
 167 /** HID class driver callback function for the processing of HID reports from the host.
 168  *
 169  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 170  *  \param[in] ReportID  Report ID of the received report from the host
 171  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 172  *  \param[in] ReportSize  Size in bytes of the received HID report
 173  */
 174 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 175                                           const void* ReportData, const uint16_t ReportSize)
 176 {
 177         // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports
 178 }