summaryrefslogtreecommitdiffstats
path: root/protocol/lufa/LUFA-120730/LUFA/Drivers/USB/Class/HIDClass.h
diff options
context:
space:
mode:
authortmk <nobody@nowhere>2013-02-11 22:57:40 +0900
committertmk <nobody@nowhere>2013-02-11 22:57:40 +0900
commit821563417565776d2dc3a02b0265e6fcd5218739 (patch)
treefd6b6ef81bcd550c7c3a9246fa9e5ccaf58a1432 /protocol/lufa/LUFA-120730/LUFA/Drivers/USB/Class/HIDClass.h
parente9e4c0edc52dbf4afe11251b8b50df130ef57423 (diff)
Now includes LUFA-120730 in repository
Diffstat (limited to 'protocol/lufa/LUFA-120730/LUFA/Drivers/USB/Class/HIDClass.h')
-rw-r--r--protocol/lufa/LUFA-120730/LUFA/Drivers/USB/Class/HIDClass.h81
1 files changed, 81 insertions, 0 deletions
diff --git a/protocol/lufa/LUFA-120730/LUFA/Drivers/USB/Class/HIDClass.h b/protocol/lufa/LUFA-120730/LUFA/Drivers/USB/Class/HIDClass.h
new file mode 100644
index 0000000000..288559c757
--- /dev/null
+++ b/protocol/lufa/LUFA-120730/LUFA/Drivers/USB/Class/HIDClass.h
@@ -0,0 +1,81 @@
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2012.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ * \brief Master include file for the library USB HID Class driver.
+ *
+ * Master include file for the library USB HID Class driver, for both host and device modes, where available.
+ *
+ * This file should be included in all user projects making use of this optional class driver, instead of
+ * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
+ */
+
+/** \ingroup Group_USBClassDrivers
+ * \defgroup Group_USBClassHID HID Class Driver
+ *
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - LUFA/Drivers/USB/Class/Device/HIDClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
+ * - LUFA/Drivers/USB/Class/Host/HIDClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
+ * - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
+ *
+ * \section Sec_ModDescription Module Description
+ * HID Class Driver module. This module contains an internal implementation of the USB HID Class, for both Device
+ * and Host USB modes. User applications can use this class driver instead of implementing the HID class manually
+ * via the low-level LUFA APIs.
+ *
+ * This module is designed to simplify the user code by exposing only the required interface needed to interface with
+ * Hosts or Devices using the USB HID Class.
+ *
+ * @{
+ */
+
+#ifndef _HID_CLASS_H_
+#define _HID_CLASS_H_
+
+ /* Macros: */
+ #define __INCLUDE_FROM_USB_DRIVER
+ #define __INCLUDE_FROM_HID_DRIVER
+
+ /* Includes: */
+ #include "../Core/USBMode.h"
+
+ #if defined(USB_CAN_BE_DEVICE)
+ #include "Device/HIDClassDevice.h"
+ #endif
+
+ #if defined(USB_CAN_BE_HOST)
+ #include "Host/HIDClassHost.h"
+ #endif
+
+#endif
+
+/** @} */
+