Demos/Device/LowLevel/Joystick/Joystick.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 Joystick demo. This file contains the main tasks of the demo and
  34  *  is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "Joystick.h"
  38
  39 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  47         sei();
  48
  49         for (;;)
  50         {
  51                 HID_Task();
  52                 USB_USBTask();
  53         }
  54 }
  55
  56 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  57 void SetupHardware(void)
  58 {
  59         /* Disable watchdog if enabled by bootloader/fuses */
  60         MCUSR &= ~(1 << WDRF);
  61         wdt_disable();
  62
  63         /* Disable clock division */
  64         clock_prescale_set(clock_div_1);
  65
  66         /* Hardware Initialization */
  67         Joystick_Init();
  68         LEDs_Init();
  69         Buttons_Init();
  70         USB_Init();
  71 }
  72
  73 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
  74  *  starts the library USB task to begin the enumeration and USB management process.
  75  */
  76 void EVENT_USB_Device_Connect(void)
  77 {
  78         /* Indicate USB enumerating */
  79         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  80 }
  81
  82 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
  83  *  the status LEDs and stops the USB management and joystick reporting tasks.
  84  */
  85 void EVENT_USB_Device_Disconnect(void)
  86 {
  87         /* Indicate USB not ready */
  88         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  89 }
  90
  91 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration
  92  *  of the USB device after enumeration - the device endpoints are configured and the joystick reporting task started.
  93  */
  94 void EVENT_USB_Device_ConfigurationChanged(void)
  95 {
  96         bool ConfigSuccess = true;
  97
  98         /* Setup HID Report Endpoint */
  99         ConfigSuccess &= Endpoint_ConfigureEndpoint(JOYSTICK_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
 100                                                     JOYSTICK_EPSIZE, ENDPOINT_BANK_SINGLE);
 101
 102         /* Indicate endpoint configuration success or failure */
 103         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 104 }
 105
 106 /** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
 107  *  the device from the USB host before passing along unhandled control requests to the library for processing
 108  *  internally.
 109  */
 110 void EVENT_USB_Device_ControlRequest(void)
 111 {
 112         /* Handle HID Class specific requests */
 113         switch (USB_ControlRequest.bRequest)
 114         {
 115                 case HID_REQ_GetReport:
 116                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 117                         {
 118                                 USB_JoystickReport_Data_t JoystickReportData;
 119
 120                                 /* Create the next HID report to send to the host */
 121                                 GetNextReport(&JoystickReportData);
 122
 123                                 Endpoint_ClearSETUP();
 124
 125                                 /* Write the report data to the control endpoint */
 126                                 Endpoint_Write_Control_Stream_LE(&JoystickReportData, sizeof(JoystickReportData));
 127                                 Endpoint_ClearOUT();
 128                         }
 129
 130                         break;
 131         }
 132 }
 133
 134 /** Fills the given HID report data structure with the next HID report to send to the host.
 135  *
 136  *  \param[out] ReportData  Pointer to a HID report data structure to be filled
 137  *
 138  *  \return Boolean true if the new report differs from the last report, false otherwise
 139  */
 140 bool GetNextReport(USB_JoystickReport_Data_t* const ReportData)
 141 {
 142         static uint8_t PrevJoyStatus    = 0;
 143         static uint8_t PrevButtonStatus = 0;
 144         uint8_t        JoyStatus_LCL    = Joystick_GetStatus();
 145         uint8_t        ButtonStatus_LCL = Buttons_GetStatus();
 146         bool           InputChanged     = false;
 147
 148         /* Clear the report contents */
 149         memset(ReportData, 0, sizeof(USB_JoystickReport_Data_t));
 150
 151         if (JoyStatus_LCL & JOY_UP)
 152           ReportData->Y = -100;
 153         else if (JoyStatus_LCL & JOY_DOWN)
 154           ReportData->Y =  100;
 155
 156         if (JoyStatus_LCL & JOY_LEFT)
 157           ReportData->X = -100;
 158         else if (JoyStatus_LCL & JOY_RIGHT)
 159           ReportData->X =  100;
 160
 161         if (JoyStatus_LCL & JOY_PRESS)
 162           ReportData->Button |= (1 << 1);
 163
 164         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 165           ReportData->Button |= (1 << 0);
 166
 167         /* Check if the new report is different to the previous report */
 168         InputChanged = (uint8_t)(PrevJoyStatus ^ JoyStatus_LCL) | (uint8_t)(PrevButtonStatus ^ ButtonStatus_LCL);
 169
 170         /* Save the current joystick status for later comparison */
 171         PrevJoyStatus    = JoyStatus_LCL;
 172         PrevButtonStatus = ButtonStatus_LCL;
 173
 174         /* Return whether the new report is different to the previous report or not */
 175         return InputChanged;
 176 }
 177
 178 /** Function to manage HID report generation and transmission to the host. */
 179 void HID_Task(void)
 180 {
 181         /* Device must be connected and configured for the task to run */
 182         if (USB_DeviceState != DEVICE_STATE_Configured)
 183           return;
 184
 185         /* Select the Joystick Report Endpoint */
 186         Endpoint_SelectEndpoint(JOYSTICK_EPNUM);
 187
 188         /* Check to see if the host is ready for another packet */
 189         if (Endpoint_IsINReady())
 190         {
 191                 USB_JoystickReport_Data_t JoystickReportData;
 192
 193                 /* Create the next HID report to send to the host */
 194                 GetNextReport(&JoystickReportData);
 195
 196                 /* Write Joystick Report Data */
 197                 Endpoint_Write_Stream_LE(&JoystickReportData, sizeof(JoystickReportData), NULL);
 198
 199                 /* Finalize the stream transfer to send the last packet */
 200                 Endpoint_ClearIN();
 201
 202                 /* Clear the report data afterwards */
 203                 memset(&JoystickReportData, 0, sizeof(JoystickReportData));
 204         }
 205 }
 206