Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 #ifndef _KEYBOARD_MOUSE_H_
  32 #define _KEYBOARD_MOUSE_H_
  33
  34         /* Includes: */
  35                 #include <avr/io.h>
  36                 #include <avr/wdt.h>
  37                 #include <avr/power.h>
  38                 #include <avr/interrupt.h>
  39                 #include <stdbool.h>
  40                 #include <string.h>
  41
  42                 #include "Descriptors.h"
  43
  44                 #include <LUFA/Drivers/Board/Joystick.h>
  45                 #include <LUFA/Drivers/Board/LEDs.h>
  46                 #include <LUFA/Drivers/Board/Buttons.h>
  47                 #include <LUFA/Drivers/USB/USB.h>
  48
  49         /* Macros: */
  50                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  51                 #define LEDMASK_USB_NOTREADY      LEDS_LED1
  52
  53                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  54                 #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
  55
  56                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  57                 #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
  58
  59                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  60                 #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
  61
  62         /* Function Prototypes: */
  63                 void SetupHardware(void);
  64
  65                 void EVENT_USB_Device_Connect(void);
  66                 void EVENT_USB_Device_Disconnect(void);
  67                 void EVENT_USB_Device_ConfigurationChanged(void);
  68                 void EVENT_USB_Device_ControlRequest(void);
  69                 void EVENT_USB_Device_StartOfFrame(void);
  70
  71                 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
  72                                                          uint8_t* const ReportID,
  73                                                          const uint8_t ReportType,
  74                                                          void* ReportData,
  75                                                          uint16_t* const ReportSize);
  76                 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
  77                                                           const uint8_t ReportID,
  78                                                           const uint8_t ReportType,
  79                                                           const void* ReportData,
  80                                                           const uint16_t ReportSize);
  81
  82 #endif
  83