LUFA/Drivers/USB/Class/HID.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 /** \ingroup Group_USBClassDrivers
  32  *  @defgroup Group_USBClassHID HID Device Class Driver - LUFA/Drivers/Class/HID.h
  33  *
  34  *  \section Sec_Dependencies Module Source Dependencies
  35  *  The following files must be built with any user project that uses this module:
  36  *    - LUFA/Drivers/USB/Class/Device/HID.c
  37  *    - LUFA/Drivers/USB/Class/Host/HID.c
  38  *    - LUFA/Drivers/USB/Class/Host/HIDParser.c
  39  *
  40  *  \section Module Description
  41  *  HID Class Driver module. This module contains an internal implementation of the USB HID Class, for both Device
  42  *  and Host USB modes. User applications can use this class driver instead of implementing the HID class manually
  43  *  via the low-level LUFA APIs.
  44  *
  45  *  This module is designed to simplify the user code by exposing only the required interface needed to interface with
  46  *  Hosts or Devices using the USB HID Class.
  47  *
  48  *  @{
  49  */
  50
  51 #ifndef _HID_CLASS_H_
  52 #define _HID_CLASS_H_
  53
  54         /* Includes: */
  55                 #include "../HighLevel/USBMode.h"
  56
  57                 #if defined(NO_STREAM_CALLBACKS)
  58                         #error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.
  59                 #endif
  60
  61                 #if defined(USB_CAN_BE_DEVICE)
  62                         #include "Device/HID.h"
  63                 #endif
  64
  65                 #if defined(USB_CAN_BE_HOST)
  66                         #include "Host/HID.h"
  67                 #endif
  68
  69 #endif
  70
  71 /** @} */