tmk_core/protocol/lufa/LUFA-git/Demos/Device/LowLevel/Joystick/Joystick.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  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  *  Header file for Joystick.c.
  34  */
  35
  36 #ifndef _JOYSTICK_H_
  37 #define _JOYSTICK_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/power.h>
  43                 #include <avr/interrupt.h>
  44                 #include <string.h>
  45
  46                 #include "Descriptors.h"
  47
  48                 #include <LUFA/Drivers/USB/USB.h>
  49                 #include <LUFA/Drivers/Board/Joystick.h>
  50                 #include <LUFA/Drivers/Board/LEDs.h>
  51                 #include <LUFA/Drivers/Board/Buttons.h>
  52                 #include <LUFA/Platform/Platform.h>
  53
  54         /* Macros: */
  55                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  56                 #define LEDMASK_USB_NOTREADY      LEDS_LED1
  57
  58                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  59                 #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
  60
  61                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  62                 #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
  63
  64                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  65                 #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
  66
  67         /* Type Defines: */
  68                 /** Type define for the joystick HID report structure, for creating and sending HID reports to the host PC.
  69                  *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
  70                  */
  71                 typedef struct
  72                 {
  73                         int8_t  X; /**< Current absolute joystick X position, as a signed 8-bit integer */
  74                         int8_t  Y; /**< Current absolute joystick Y position, as a signed 8-bit integer */
  75                         int8_t  Z; /**< Current absolute joystick Z position, as a signed 8-bit integer */
  76                         uint8_t Button; /**< Bit mask of the currently pressed joystick buttons */
  77                 } USB_JoystickReport_Data_t;
  78
  79         /* Function Prototypes: */
  80                 void SetupHardware(void);
  81                 void HID_Task(void);
  82
  83                 void EVENT_USB_Device_Connect(void);
  84                 void EVENT_USB_Device_Disconnect(void);
  85                 void EVENT_USB_Device_ConfigurationChanged(void);
  86                 void EVENT_USB_Device_ControlRequest(void);
  87
  88                 bool GetNextReport(USB_JoystickReport_Data_t* const ReportData);
  89
  90 #endif
  91