git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Demo/FreeRTOS_Plus_UDP_and_CLI_LPC1830_GCC/ThirdParty/LPCOpen/LPCUSBLib/Drivers/USB/Class/HIDClass.h

   1 /*\r
   2  * @brief Master include file for the library USB HID Class driver, for both host and device modes\r
   3  *\r
   4  * @note\r
   5  * Copyright(C) NXP Semiconductors, 2012\r
   6  * Copyright(C) Dean Camera, 2011, 2012\r
   7  * All rights reserved.\r
   8  *\r
   9  * @par\r
  10  * Software that is described herein is for illustrative purposes only\r
  11  * which provides customers with programming information regarding the\r
  12  * LPC products.  This software is supplied "AS IS" without any warranties of\r
  13  * any kind, and NXP Semiconductors and its licensor disclaim any and\r
  14  * all warranties, express or implied, including all implied warranties of\r
  15  * merchantability, fitness for a particular purpose and non-infringement of\r
  16  * intellectual property rights.  NXP Semiconductors assumes no responsibility\r
  17  * or liability for the use of the software, conveys no license or rights under any\r
  18  * patent, copyright, mask work right, or any other intellectual property rights in\r
  19  * or to any products. NXP Semiconductors reserves the right to make changes\r
  20  * in the software without notification. NXP Semiconductors also makes no\r
  21  * representation or warranty that such application will be suitable for the\r
  22  * specified use without further testing or modification.\r
  23  *\r
  24  * @par\r
  25  * Permission to use, copy, modify, and distribute this software and its\r
  26  * documentation is hereby granted, under NXP Semiconductors' and its\r
  27  * licensor's relevant copyrights in the software, without fee, provided that it\r
  28  * is used in conjunction with NXP Semiconductors microcontrollers.  This\r
  29  * copyright, permission, and disclaimer notice must appear in all copies of\r
  30  * this code.\r
  31  */\r
  32 \r
  33 /** @ingroup Group_USBClassDrivers\r
  34  *  @defgroup Group_USBClassHID HID Class Driver\r
  35  *\r
  36  *  @section Sec_Dependencies Module Source Dependencies\r
  37  *  The following files must be built with any user project that uses this module:\r
  38  *    - LPCUSBlib/Drivers/USB/Class/Device/HID.c <i>(Makefile source module name: LPCUSBLIB_SRC_USBCLASS)</i>\r
  39  *    - LPCUSBlib/Drivers/USB/Class/Host/HID.c <i>(Makefile source module name: LPCUSBLIB_SRC_USBCLASS)</i>\r
  40  *    - LPCUSBlib/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LPCUSBLIB_SRC_USB)</i>\r
  41  *\r
  42  *  @section Sec_ModDescription Module Description\r
  43  *  HID Class Driver module. This module contains an internal implementation of the USB HID Class, for both Device\r
  44  *  and Host USB modes. User applications can use this class driver instead of implementing the HID class manually\r
  45  *  via the low-level nxpUSBlib APIs.\r
  46  *\r
  47  *  This module is designed to simplify the user code by exposing only the required interface needed to interface with\r
  48  *  Hosts or Devices using the USB HID Class.\r
  49  *\r
  50  *  @{\r
  51  */\r
  52 \r
  53 #ifndef _HID_CLASS_H_\r
  54 #define _HID_CLASS_H_\r
  55 \r
  56         /* Macros: */\r
  57                 #define __INCLUDE_FROM_USB_DRIVER\r
  58                 #define __INCLUDE_FROM_HID_DRIVER\r
  59 \r
  60         /* Includes: */\r
  61                 #include "../Core/USBMode.h"\r
  62 \r
  63                 #if defined(USB_CAN_BE_DEVICE)\r
  64                         #include "Device/HIDClassDevice.h"\r
  65                 #endif\r
  66 \r
  67                 #if defined(USB_CAN_BE_HOST)\r
  68                         #include "Host/HIDClassHost.h"\r
  69                 #endif\r
  70 \r
  71 #endif\r
  72 \r
  73 /** @} */\r
  74 \r