Demos/Host/MouseHostWithParser/HIDReport.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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  *  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>            // USB Functionality
  41
  42                 #include "MouseHostWithParser.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 value for a X axis movement */
  52                 #define USAGE_X                     0x30
  53
  54                 /** HID Report Descriptor Usage value for a Y axis movement */
  55                 #define USAGE_Y                     0x31
  56
  57         /* Enums: */
  58                 /** Enum for the possible return codes of the GetHIDReportData() function. */
  59                 enum MouseHostWithParser_GetHIDReportDataCodes_t
  60                 {
  61                         ParseSuccessful         = 0, /**< HID report descriptor parsed successfully */
  62                         ParseError              = 1, /**< Failed to fully process the HID report descriptor */
  63                         ParseControlError       = 2, /**< Control error occurred while trying to read the device HID descriptor */
  64                 };
  65
  66         /* Type Defines: */
  67                 /** Type define for a HID descriptor. */
  68                 typedef struct
  69                 {
  70                         USB_Descriptor_Header_t  Header; /**< Regular descriptor header containing the descriptor's type and length */
  71
  72                         uint16_t                 HIDSpec; /**< Implemented HID class specification, in BCD encoded format */
  73                         uint8_t                  CountryCode; /**< Country code value for localized hardware */
  74
  75                         uint8_t                  TotalHIDDescriptors; /**< Total number of HID report descriptors in the current interface */
  76
  77                         uint8_t                  HIDReportType; /**< HID report type of the first HID report descriptor */
  78                         uint16_t                 HIDReportLength; /**< Total size in bytes of the first HID report descriptor */
  79                 } USB_Descriptor_HID_t;
  80
  81         /* External Variables: */
  82                 extern uint16_t         HIDReportSize;
  83                 extern HID_ReportInfo_t HIDReportInfo;
  84
  85         /* Function Prototypes: */
  86                 uint8_t GetHIDReportData(void);
  87
  88 #endif