Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.h

   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  *  Header file for MouseHost.c.
  34  */
  35
  36 #ifndef _MOUSE_HOST_H_
  37 #define _MOUSE_HOST_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/pgmspace.h>
  43                 #include <avr/power.h>
  44                 #include <avr/interrupt.h>
  45                 #include <stdio.h>
  46
  47                 #include <LUFA/Drivers/Misc/TerminalCodes.h>
  48                 #include <LUFA/Drivers/Peripheral/Serial.h>
  49                 #include <LUFA/Drivers/Board/LEDs.h>
  50                 #include <LUFA/Drivers/USB/USB.h>
  51                 #include <LUFA/Platform/Platform.h>
  52
  53         /* Macros: */
  54                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  55                 #define LEDMASK_USB_NOTREADY        LEDS_LED1
  56
  57                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  58                 #define LEDMASK_USB_ENUMERATING     (LEDS_LED2 | LEDS_LED3)
  59
  60                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  61                 #define LEDMASK_USB_READY           (LEDS_LED2 | LEDS_LED4)
  62
  63                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  64                 #define LEDMASK_USB_ERROR           (LEDS_LED1 | LEDS_LED3)
  65
  66                 /** HID Report Descriptor Usage Page value for a toggle button. */
  67                 #define USAGE_PAGE_BUTTON           0x09
  68
  69                 /** HID Report Descriptor Usage Page value for a Generic Desktop Control. */
  70                 #define USAGE_PAGE_GENERIC_DCTRL    0x01
  71
  72                 /** HID Report Descriptor Usage for a Mouse. */
  73                 #define USAGE_MOUSE                 0x02
  74
  75                 /** HID Report Descriptor Usage value for a X axis movement. */
  76                 #define USAGE_X                     0x30
  77
  78                 /** HID Report Descriptor Usage value for a Y axis movement. */
  79                 #define USAGE_Y                     0x31
  80
  81                 /** HID Report Descriptor Usage value for a Scroll Wheel movement. */
  82                 #define USAGE_SCROLL_WHEEL          0x38
  83
  84         /* Function Prototypes: */
  85                 void SetupHardware(void);
  86                 void MouseHost_Task(void);
  87
  88                 void EVENT_USB_Host_HostError(const uint8_t ErrorCode);
  89                 void EVENT_USB_Host_DeviceAttached(void);
  90                 void EVENT_USB_Host_DeviceUnattached(void);
  91                 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
  92                                                             const uint8_t SubErrorCode);
  93                 void EVENT_USB_Host_DeviceEnumerationComplete(void);
  94
  95                 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem);
  96
  97 #endif
  98