tmk_core/protocol/lufa/LUFA-git/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.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 HIDReport.c.
  34  */
  35
  36 #ifndef _HID_REPORT_H_
  37 #define _HID_REPORT_H_
  38
  39         /* Includes: */
  40                 #include <LUFA/Drivers/USB/USB.h>
  41
  42                 #include "JoystickHostWithParser.h"
  43
  44         /* Macros: */
  45                 /** HID Report Descriptor Usage Page value for a toggle button. */
  46                 #define USAGE_PAGE_BUTTON           0x09
  47
  48                 /** HID Report Descriptor Usage Page value for a Generic Desktop Control. */
  49                 #define USAGE_PAGE_GENERIC_DCTRL    0x01
  50
  51                 /** HID Report Descriptor Usage for a Joystick. */
  52                 #define USAGE_JOYSTICK              0x04
  53
  54                 /** HID Report Descriptor Usage value for a X axis movement. */
  55                 #define USAGE_X                     0x30
  56
  57                 /** HID Report Descriptor Usage value for a Y axis movement. */
  58                 #define USAGE_Y                     0x31
  59
  60         /* Enums: */
  61                 /** Enum for the possible return codes of the \ref GetHIDReportData() function. */
  62                 enum JoystickHostWithParser_GetHIDReportDataCodes_t
  63                 {
  64                         ParseSuccessful         = 0, /**< HID report descriptor parsed successfully */
  65                         ParseError              = 1, /**< Failed to fully process the HID report descriptor */
  66                         ParseControlError       = 2, /**< Control error occurred while trying to read the device HID descriptor */
  67                 };
  68
  69         /* External Variables: */
  70                 extern uint16_t         HIDReportSize;
  71                 extern HID_ReportInfo_t HIDReportInfo;
  72
  73         /* Function Prototypes: */
  74                 uint8_t GetHIDReportData(void);
  75
  76                 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem);
  77
  78 #endif
  79