lib/lufa/Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  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 disclaims 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  *  Device Mode USB Mouse functionality for the MouseHostDevice demo. This file contains the Device mode
  34  *  USB Mouse related code of the demo and is responsible for all the Device mode Mouse functionality.
  35  */
  36
  37 #include "DeviceFunctions.h"
  38
  39 /** Buffer to hold the previously generated Mouse Device HID report, for comparison purposes inside the HID class driver. */
  40 static 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_Device_Interface =
  47         {
  48                 .Config =
  49                         {
  50                                 .InterfaceNumber            = INTERFACE_ID_Mouse,
  51                                 .ReportINEndpoint           =
  52                                         {
  53                                                 .Address            = MOUSE_EPADDR,
  54                                                 .Size               = MOUSE_EPSIZE,
  55                                                 .Banks              = 1,
  56                                         },
  57                                 .PrevReportINBuffer         = PrevMouseHIDReportBuffer,
  58                                 .PrevReportINBufferSize     = sizeof(PrevMouseHIDReportBuffer),
  59                         },
  60         };
  61
  62
  63 /** Event handler for the library USB WakeUp event. */
  64 void EVENT_USB_Device_Connect(void)
  65 {
  66         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  67 }
  68
  69 /** Event handler for the library USB Suspend event. */
  70 void EVENT_USB_Device_Disconnect(void)
  71 {
  72         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  73 }
  74
  75 /** Event handler for the library USB Configuration Changed event. */
  76 void EVENT_USB_Device_ConfigurationChanged(void)
  77 {
  78         LEDs_SetAllLEDs(LEDMASK_USB_READY);
  79
  80         if (!(HID_Device_ConfigureEndpoints(&Mouse_HID_Device_Interface)))
  81           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  82
  83         USB_Device_EnableSOFEvents();
  84 }
  85
  86 /** Event handler for the library USB Control Request reception event. */
  87 void EVENT_USB_Device_ControlRequest(void)
  88 {
  89         HID_Device_ProcessControlRequest(&Mouse_HID_Device_Interface);
  90 }
  91
  92 /** Event handler for the USB device Start Of Frame event. */
  93 void EVENT_USB_Device_StartOfFrame(void)
  94 {
  95         HID_Device_MillisecondElapsed(&Mouse_HID_Device_Interface);
  96 }
  97
  98 /** HID class driver callback function for the creation of HID reports to the host.
  99  *
 100  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 101  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 102  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 103  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 104  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent)
 105  *
 106  *  \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
 107  */
 108 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 109                                          uint8_t* const ReportID,
 110                                          const uint8_t ReportType,
 111                                          void* ReportData,
 112                                          uint16_t* const ReportSize)
 113 {
 114         USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
 115
 116         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 117         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 118
 119         if (JoyStatus_LCL & JOY_UP)
 120           MouseReport->Y = -1;
 121         else if (JoyStatus_LCL & JOY_DOWN)
 122           MouseReport->Y =  1;
 123
 124         if (JoyStatus_LCL & JOY_RIGHT)
 125           MouseReport->X =  1;
 126         else if (JoyStatus_LCL & JOY_LEFT)
 127           MouseReport->X = -1;
 128
 129         if (JoyStatus_LCL & JOY_PRESS)
 130           MouseReport->Button |= (1 << 0);
 131
 132         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 133           MouseReport->Button |= (1 << 1);
 134
 135         *ReportSize = sizeof(USB_MouseReport_Data_t);
 136         return true;
 137 }
 138
 139 /** HID class driver callback function for the processing of HID reports from the host.
 140  *
 141  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 142  *  \param[in] ReportID    Report ID of the received report from the host
 143  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 144  *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
 145  *  \param[in] ReportSize  Size in bytes of the received HID report
 146  */
 147 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 148                                           const uint8_t ReportID,
 149                                           const uint8_t ReportType,
 150                                           const void* ReportData,
 151                                           const uint16_t ReportSize)
 152 {
 153         // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports
 154 }
 155