Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

HIDClass.h 3.0KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. /*
  2. LUFA Library
  3. Copyright (C) Dean Camera, 2014.
  4. dean [at] fourwalledcubicle [dot] com
  5. www.lufa-lib.org
  6. */
  7. /*
  8. Copyright 2014 Dean Camera (dean [at] fourwalledcubicle [dot] com)
  9. Permission to use, copy, modify, distribute, and sell this
  10. software and its documentation for any purpose is hereby granted
  11. without fee, provided that the above copyright notice appear in
  12. all copies and that both that the copyright notice and this
  13. permission notice and warranty disclaimer appear in supporting
  14. documentation, and that the name of the author not be used in
  15. advertising or publicity pertaining to distribution of the
  16. software without specific, written prior permission.
  17. The author disclaims all warranties with regard to this
  18. software, including all implied warranties of merchantability
  19. and fitness. In no event shall the author be liable for any
  20. special, indirect or consequential damages or any damages
  21. whatsoever resulting from loss of use, data or profits, whether
  22. in an action of contract, negligence or other tortious action,
  23. arising out of or in connection with the use or performance of
  24. this software.
  25. */
  26. /** \file
  27. * \brief Master include file for the library USB HID Class driver.
  28. *
  29. * Master include file for the library USB HID Class driver, for both host and device modes, where available.
  30. *
  31. * This file should be included in all user projects making use of this optional class driver, instead of
  32. * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.
  33. */
  34. /** \ingroup Group_USBClassDrivers
  35. * \defgroup Group_USBClassHID HID Class Driver
  36. * \brief USB class driver for the USB-IF Human Interface Device (HID) class standard.
  37. *
  38. * \section Sec_USBClassHID_Dependencies Module Source Dependencies
  39. * The following files must be built with any user project that uses this module:
  40. * - LUFA/Drivers/USB/Class/Device/HIDClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  41. * - LUFA/Drivers/USB/Class/Host/HIDClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  42. * - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
  43. *
  44. * \section Sec_USBClassHID_ModDescription Module Description
  45. * HID Class Driver module. This module contains an internal implementation of the USB HID Class, for both Device
  46. * and Host USB modes. User applications can use this class driver instead of implementing the HID class manually
  47. * via the low-level LUFA APIs.
  48. *
  49. * This module is designed to simplify the user code by exposing only the required interface needed to interface with
  50. * Hosts or Devices using the USB HID Class.
  51. *
  52. * @{
  53. */
  54. #ifndef _HID_CLASS_H_
  55. #define _HID_CLASS_H_
  56. /* Macros: */
  57. #define __INCLUDE_FROM_USB_DRIVER
  58. #define __INCLUDE_FROM_HID_DRIVER
  59. /* Includes: */
  60. #include "../Core/USBMode.h"
  61. #if defined(USB_CAN_BE_DEVICE)
  62. #include "Device/HIDClassDevice.h"
  63. #endif
  64. #if defined(USB_CAN_BE_HOST)
  65. #include "Host/HIDClassHost.h"
  66. #endif
  67. #endif
  68. /** @} */