LUFA/Drivers/USB/Class/HID.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 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  *  \brief Master include file for the library USB HID Class driver.
  33  *
  34  *  Master include file for the library USB HID Class driver, for both host and device modes, where available.
  35  *
  36  *  This file should be included in all user projects making use of this optional class driver, instead of
  37  *  including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
  38  */
  39
  40 /** \ingroup Group_USBClassDrivers
  41  *  @defgroup Group_USBClassHID HID Class Driver - LUFA/Drivers/Class/HID.h
  42  *
  43  *  \section Sec_Dependencies Module Source Dependencies
  44  *  The following files must be built with any user project that uses this module:
  45  *    - LUFA/Drivers/USB/Class/Device/HID.c
  46  *    - LUFA/Drivers/USB/Class/Host/HID.c
  47  *    - LUFA/Drivers/USB/Class/Host/HIDParser.c
  48  *
  49  *  \section Module Description
  50  *  HID Class Driver module. This module contains an internal implementation of the USB HID Class, for both Device
  51  *  and Host USB modes. User applications can use this class driver instead of implementing the HID class manually
  52  *  via the low-level LUFA APIs.
  53  *
  54  *  This module is designed to simplify the user code by exposing only the required interface needed to interface with
  55  *  Hosts or Devices using the USB HID Class.
  56  *
  57  *  @{
  58  */
  59
  60 #ifndef _HID_CLASS_H_
  61 #define _HID_CLASS_H_
  62
  63         /* Macros: */
  64                 #define __INCLUDE_FROM_HID_DRIVER
  65                 #define __INCLUDE_FROM_USB_DRIVER
  66
  67         /* Includes: */
  68                 #include "../HighLevel/USBMode.h"
  69
  70                 #if defined(NO_STREAM_CALLBACKS)
  71                         #error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.
  72                 #endif
  73
  74                 #if defined(USB_CAN_BE_DEVICE)
  75                         #include "Device/HID.h"
  76                 #endif
  77
  78                 #if defined(USB_CAN_BE_HOST)
  79                         #include "Host/HID.h"
  80                 #endif
  81
  82 #endif
  83
  84 /** @} */