HID.h 5.78 KB
 Dean Camera committed Jun 14, 2009 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 /* LUFA Library Copyright (C) Dean Camera, 2009. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, 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. */ /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDHost HID Class Host Mode Driver *  Dean Camera committed Jul 14, 2009 34 35 36 37  * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/HID.c *  Dean Camera committed Jun 14, 2009 38 39 40 41 42 43 44 45 46 47 48 49  * \section Module Description * Host Mode USB Class driver framework interface, for the HID USB Class driver. * * @{ */ #ifndef __HID_CLASS_HOST_H__ #define __HID_CLASS_HOST_H__ /* Includes: */ #include "../../USB.h" #include "../Common/HID.h"  Dean Camera committed Aug 11, 2009 50  #include "HIDParser.h"  Dean Camera committed Jun 14, 2009 51 52 53 54 55 56  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif  Dean Camera committed Jun 15, 2009 57  /* Public Interface - May be used in end-application: */  Dean Camera committed Jul 27, 2009 58 59 60 61 62 63 64 65 66 67 68  /* Type Defines: */ /** Class state structure. An instance of this structure should be made within the user application, * and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This * stores each HID interface's configuration and state information. */ typedef struct { const struct { uint8_t DataINPipeNumber; /**< Pipe number of the HID interface's IN data pipe */ uint8_t DataOUTPipeNumber; /**< Pipe number of the HID interface's OUT data pipe */  69 70 71 72  uint8_t HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific * boot subclass protocol is required (e.g. keyboard, mouse), or * leave as 0 to match against the first HID interface found  Dean Camera committed Jul 27, 2009 73  */  Dean Camera committed Jul 27, 2009 74 75 76 77 78  } Config; /**< Config data for the USB class interface within the device. All elements in this section * must be set or the interface will fail to enumerate and operate correctly. */ struct {  79 80 81 82 83  bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid * after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the * Configured state */ uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device */  Dean Camera committed Aug 11, 2009 84   Dean Camera committed Jul 27, 2009 85 86  uint16_t DataINPipeSize; /**< Size in bytes of the HID interface's IN data pipe */ uint16_t DataOUTPipeSize; /**< Size in bytes of the HID interface's OUT data pipe */  87 88 89 90  bool SupportsBootSubClass; /**< Indicates if the current interface instance supports the HID Boot * Protocol when enabled via \ref USB_HID_Host_SetProtocol() */  Dean Camera committed Jul 27, 2009 91 92 93 94 95 96 97 98 99 100  } State; /**< State data for the USB class interface within the device. All elements in this section * may be set to initial values, but may also be ignored to default to sane values when * the interface is enumerated. */ } USB_ClassInfo_HID_Host_t; /* Enums: */ enum { HID_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */  Dean Camera committed Jul 27, 2009 101 102  HID_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */ HID_ENUMERROR_NoHIDInterfaceFound = 2, /**< A compatible HID interface was not found in the device's Configuration Descriptor */  Dean Camera committed Aug 13, 2009 103  HID_ENUMERROR_EndpointsNotFound = 3, /**< Compatible HID endpoints were not found in the device's HID interface */  Dean Camera committed Aug 11, 2009 104  } HIDHost_EnumerationFailure_ErrorCodes_t;  Dean Camera committed Jul 27, 2009 105   Dean Camera committed Jun 15, 2009 106  /* Function Prototypes: */  Dean Camera committed Jul 27, 2009 107  void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo);  Dean Camera committed Jul 27, 2009 108 109  uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint16_t ConfigDescriptorLength, uint8_t* DeviceConfigDescriptor);  Dean Camera committed Aug 11, 2009 110   111 112  bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo); uint8_t USB_HID_Host_SetProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool UseReportProtocol);  Dean Camera committed Jun 14, 2009 113   Dean Camera committed Jul 27, 2009 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128  /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */ #define HID_INTERFACE_CLASS 0x03 #define HID_FOUND_DATAPIPE_IN (1 << 0) #define HID_FOUND_DATAPIPE_OUT (1 << 1) /* Function Prototypes: */ #if defined(INCLUDE_FROM_HID_CLASS_HOST_C) static uint8_t DComp_HID_Host_NextHIDInterface(void* CurrentDescriptor); static uint8_t DComp_HID_Host_NextInterfaceHIDDataEndpoint(void* CurrentDescriptor); #endif #endif  Dean Camera committed Jun 14, 2009 129 130 131 132 133 134 135 136  /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */