Demos/Device/ClassDriver/Mouse/Mouse.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 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_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
  62 /** Main program entry point. This routine contains the overall program flow, including initial
  63  *  setup of all components and the main program loop.
  64  */
  65 int main(void)
  66 {
  67         SetupHardware();
  68
  69         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  70         GlobalInterruptEnable();
  71
  72         for (;;)
  73         {
  74                 HID_Device_USBTask(&Mouse_HID_Interface);
  75                 USB_USBTask();
  76         }
  77 }
  78
  79 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  80 void SetupHardware(void)
  81 {
  82         #if (ARCH == ARCH_AVR8)
  83                 /* Disable watchdog if enabled by bootloader/fuses */
  84                 MCUSR &= ~(1 << WDRF);
  85                 wdt_disable();
  86
  87                 /* Disable clock division */
  88                 clock_prescale_set(clock_div_1);
  89         #elif (ARCH == ARCH_UC3)
  90                 /* Initialize interrupt subsystem */
  91                 INTC_Init();
  92                 INTC_RegisterGroupHandler(AVR32_USBB_IRQ, AVR32_INTC_INT0, USB_GEN_vect);
  93
  94                 /* Select slow startup, external high frequency crystal attached to OSC0 */
  95                 AVR32_PM.OSCCTRL0.startup = 6;
  96                 AVR32_PM.OSCCTRL0.mode    = 7;
  97                 AVR32_PM.MCCTRL.osc0en    = true;
  98                 while (!(AVR32_PM.POSCSR.osc0rdy));
  99
 100                 /* Switch CPU core to use OSC0 as the system clock */
 101                 AVR32_PM.MCCTRL.mcsel     = 1;
 102
 103                 /* Start PLL1 to feed into the USB generic clock module */
 104                 AVR32_PM.PLL[1].pllmul    = (F_USB / F_CPU) ? (((F_USB / F_CPU) - 1) / 2) : 0;
 105                 AVR32_PM.PLL[1].plldiv    = 0;
 106                 AVR32_PM.PLL[1].pllosc    = 0;
 107                 AVR32_PM.PLL[1].pllen     = true;
 108                 while (!(AVR32_PM.POSCSR.lock1));
 109         #endif
 110
 111         /* Hardware Initialization */
 112         Joystick_Init();
 113         LEDs_Init();
 114         Buttons_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         bool ConfigSuccess = true;
 134
 135         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Mouse_HID_Interface);
 136
 137         USB_Device_EnableSOFEvents();
 138
 139         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 140 }
 141
 142 /** Event handler for the library USB Control Request reception event. */
 143 void EVENT_USB_Device_ControlRequest(void)
 144 {
 145         HID_Device_ProcessControlRequest(&Mouse_HID_Interface);
 146 }
 147
 148 /** Event handler for the USB device Start Of Frame event. */
 149 void EVENT_USB_Device_StartOfFrame(void)
 150 {
 151         HID_Device_MillisecondElapsed(&Mouse_HID_Interface);
 152 }
 153
 154 /** HID class driver callback function for the creation of HID reports to the host.
 155  *
 156  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 157  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 158  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 159  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 160  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 161  *
 162  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 163  */
 164 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 165                                          uint8_t* const ReportID,
 166                                          const uint8_t ReportType,
 167                                          void* ReportData,
 168                                          uint16_t* const ReportSize)
 169 {
 170         USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
 171
 172         uint_reg_t JoyStatus_LCL    = Joystick_GetStatus();
 173         uint_reg_t ButtonStatus_LCL = Buttons_GetStatus();
 174
 175         if (JoyStatus_LCL & JOY_UP)
 176           MouseReport->Y = -1;
 177         else if (JoyStatus_LCL & JOY_DOWN)
 178           MouseReport->Y =  1;
 179
 180         if (JoyStatus_LCL & JOY_LEFT)
 181           MouseReport->X = -1;
 182         else if (JoyStatus_LCL & JOY_RIGHT)
 183           MouseReport->X =  1;
 184
 185         if (JoyStatus_LCL & JOY_PRESS)
 186           MouseReport->Button |= (1 << 0);
 187
 188         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 189           MouseReport->Button |= (1 << 1);
 190
 191         *ReportSize = sizeof(USB_MouseReport_Data_t);
 192         return true;
 193 }
 194
 195 /** HID class driver callback function for the processing of HID reports from the host.
 196  *
 197  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 198  *  \param[in] ReportID    Report ID of the received report from the host
 199  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 200  *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
 201  *  \param[in] ReportSize  Size in bytes of the received HID report
 202  */
 203 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 204                                           const uint8_t ReportID,
 205                                           const uint8_t ReportType,
 206                                           const void* ReportData,
 207                                           const uint16_t ReportSize)
 208 {
 209         // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports
 210 }
 211