HID.h 16.2 KB
 Dean Camera committed May 08, 2010 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 34 35 36 37 38 39 40 41 42 43 44 /* LUFA Library Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2010 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 Host mode driver for the library USB HID Class driver. * * Host mode driver for the library USB HID Class driver. * * \note This file should not be included directly. It is automatically included as needed by the class driver * dispatch header located in LUFA/Drivers/USB/Class/HID.h. */ /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDHost HID Class Host Mode Driver * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module:  Dean Camera committed Jul 19, 2010 45 46  * - LUFA/Drivers/USB/Class/Host/HID.c (Makefile source module name: LUFA_SRC_USBCLASS) * - LUFA/Drivers/USB/Class/Host/HIDParser.c (Makefile source module name: LUFA_SRC_USB)  Dean Camera committed May 08, 2010 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73  * * \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" #include "HIDParser.h" /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* Preprocessor Checks: */ #if !defined(__INCLUDE_FROM_HID_DRIVER) #error Do not include this file directly. Include LUFA/Drivers/Class/HID.h instead. #endif /* Public Interface - May be used in end-application: */ /* Macros: */  Dean Camera committed Jun 03, 2010 74  /** Error code for some HID Host functions, indicating a logical (and not hardware) error. */  Dean Camera committed May 08, 2010 75 76 77 78 79 80 81 82 83 84 85 86 87  #define HID_ERROR_LOGICAL 0x80 /* Type Defines: */ /** \brief HID Class Host Mode Configuration and State Structure. * * 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 {  Dean Camera committed Jun 17, 2010 88 89  uint8_t DataINPipeNumber; /**< Pipe number of the HID interface's IN data pipe. */ bool DataINPipeDoubleBank; /**< Indicates if the HID interface's IN data pipe should use double banking. */  Dean Camera committed May 08, 2010 90   Dean Camera committed Jun 17, 2010 91 92  uint8_t DataOUTPipeNumber; /**< Pipe number of the HID interface's OUT data pipe. */ bool DataOUTPipeDoubleBank; /**< Indicates if the HID interface's OUT data pipe should use double banking. */  Dean Camera committed May 08, 2010 93 94  uint8_t HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific  95 96  * boot subclass protocol is required, a value from the \ref HID_BootProtocols_t * enum.  Dean Camera committed May 08, 2010 97 98 99  */ #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY) HID_ReportInfo_t* HIDParserData; /**< HID parser data to store the parsed HID report data, when boot protocol  Dean Camera committed Jun 17, 2010 100  * is not used.  Dean Camera committed May 08, 2010 101 102 103 104 105 106 107 108 109 110 111 112  * * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, * this method is unavailable. */ #endif } 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 { bool IsActive; /**< 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  Dean Camera committed Jun 17, 2010 113  * Configured state.  Dean Camera committed May 08, 2010 114  */  Dean Camera committed Jun 17, 2010 115  uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device. */  Dean Camera committed May 08, 2010 116   Dean Camera committed Jun 17, 2010 117 118  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. */  Dean Camera committed May 08, 2010 119 120  bool SupportsBootProtocol; /**< Indicates if the current interface instance supports the HID Boot  Dean Camera committed Jun 17, 2010 121  * Protocol when enabled via \ref HID_Host_SetBootProtocol().  Dean Camera committed May 08, 2010 122 123 124 125 126  */ bool DeviceUsesOUTPipe; /**< Indicates if the current interface instance uses a separate OUT data pipe for * OUT reports, or if OUT reports are sent via the control pipe instead. */ bool UsingBootProtocol; /**< Indicates that the interface is currently initialized in Boot Protocol mode */  Dean Camera committed Jun 17, 2010 127  uint16_t HIDReportSize; /**< Size in bytes of the HID report descriptor in the device. */  Dean Camera committed May 08, 2010 128   Dean Camera committed Jun 17, 2010 129  uint8_t LargestReportSize; /**< Largest report the device will send, in bytes. */  Dean Camera committed May 08, 2010 130 131 132 133 134 135 136 137  } 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 for the possible error codes returned by the \ref HID_Host_ConfigurePipes() function. */  Dean Camera committed Sep 28, 2010 138  enum HID_Host_EnumerationFailure_ErrorCodes_t  Dean Camera committed May 08, 2010 139  {  Dean Camera committed Jun 17, 2010 140 141 142 143 144  HID_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully. */ 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. */ HID_ENUMERROR_NoHIDDescriptorFound = 3, /**< The HID descriptor was not found in the device's HID interface. */ HID_ENUMERROR_EndpointsNotFound = 4, /**< Compatible HID endpoints were not found in the device's HID interface. */  Dean Camera committed May 08, 2010 145 146 147 148 149 150 151 152 153 154 155 156  }; /* Function Prototypes: */ /** Host interface configuration routine, to configure a given HID host interface instance using the Configuration * Descriptor read from an attached USB device. This function automatically updates the given HID Host instance's * state values and configures the pipes required to communicate with the interface if it is found within the * device. This should be called once after the stack has enumerated the attached device, while the host state * machine is in the Addressed state. * * \note Once the device pipes are configured, the HID device's reporting protocol must be set via a call * to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function. *  Dean Camera committed Jun 17, 2010 157 158 159  * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state. * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor. * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor.  Dean Camera committed May 08, 2010 160  *  Dean Camera committed Sep 28, 2010 161  * \return A value from the \ref HID_Host_EnumerationFailure_ErrorCodes_t enum.  Dean Camera committed May 08, 2010 162  */  Dean Camera committed Jul 21, 2010 163 164  uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,  Dean Camera committed May 08, 2010 165 166 167 168 169  void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3); /** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe. *  Dean Camera committed Jun 17, 2010 170  * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the  Dean Camera committed Jun 15, 2010 171  * call will fail.  Dean Camera committed May 08, 2010 172 173 174 175  * * \note The destination buffer should be large enough to accommodate the largest report that the attached device * can generate. *  Dean Camera committed Jun 17, 2010 176 177  * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state. * \param[in] Buffer Buffer to store the received report into.  Dean Camera committed May 08, 2010 178  *  Dean Camera committed Jun 17, 2010 179  * \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum.  Dean Camera committed May 08, 2010 180  */  Dean Camera committed Jul 21, 2010 181 182  uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);  Dean Camera committed May 08, 2010 183 184 185 186  #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY) /** Receives a HID IN report from the attached device, by the report ID. *  Dean Camera committed Jun 15, 2010 187 188  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 189 190 191  * * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable. *  Dean Camera committed Jun 17, 2010 192 193 194  * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state. * \param[in] ReportID Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch. * \param[in] Buffer Buffer to store the received report into.  Dean Camera committed May 08, 2010 195  *  Dean Camera committed Jun 17, 2010 196  * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.  Dean Camera committed May 08, 2010 197  */  Dean Camera committed Jul 21, 2010 198 199  uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,  Dean Camera committed May 08, 2010 200 201 202  void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3); #endif  Dean Camera committed May 09, 2010 203 204  /** Sends an OUT or FEATURE report to the currently attached HID device, using the device's OUT pipe if available, * or the device's Control pipe if not.  Dean Camera committed May 08, 2010 205  *  Dean Camera committed Jun 15, 2010 206 207  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 208 209 210 211  * * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed * from the parameter list of this function. *  Dean Camera committed Jun 17, 2010 212 213  * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state. * \param[in] ReportID Report ID of the report to send to the device, or 0 if the device does not use report IDs.  214  * \param[in] ReportType Type of report to issue to the device, either \ref HID_REPORT_ITEM_Out or \ref HID_REPORT_ITEM_Feature.  Dean Camera committed Jun 17, 2010 215 216  * \param[in] Buffer Buffer containing the report to send to the attached device. * \param[in] ReportSize Report size in bytes to send to the attached device.  Dean Camera committed May 08, 2010 217 218  * * \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in  Dean Camera committed Jun 17, 2010 219  * the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise.  Dean Camera committed May 08, 2010 220 221 222 223 224  */ uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY) const uint8_t ReportID, #endif  Dean Camera committed Jul 21, 2010 225 226 227  const uint8_t ReportType, void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)  Dean Camera committed May 08, 2010 228  #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)  Dean Camera committed May 09, 2010 229  ATTR_NON_NULL_PTR_ARG(4);  Dean Camera committed May 08, 2010 230  #else  Dean Camera committed May 09, 2010 231  ATTR_NON_NULL_PTR_ARG(3);  Dean Camera committed May 08, 2010 232 233 234 235  #endif /** Determines if a HID IN report has been received from the attached device on the data IN pipe. *  Dean Camera committed Jun 15, 2010 236 237  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 238  *  Dean Camera committed Jun 17, 2010 239  * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state.  Dean Camera committed May 08, 2010 240  *  Dean Camera committed Jun 17, 2010 241  * \return Boolean true if a report has been received, false otherwise.  Dean Camera committed May 08, 2010 242 243 244 245 246 247 248 249  */ bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** Switches the attached HID device's reporting protocol over to the Boot Report protocol mode, on supported devices. * * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method must still be called * to explicitly place the attached device into boot protocol mode before use. *  Dean Camera committed Jun 17, 2010 250  * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state.  Dean Camera committed May 08, 2010 251 252  * * \return \ref HID_ERROR_LOGICAL if the device does not support Boot Protocol mode, a value from the  Dean Camera committed Jun 17, 2010 253  * \ref USB_Host_SendControlErrorCodes_t enum otherwise.  Dean Camera committed May 08, 2010 254 255 256 257 258 259 260 261 262 263 264 265 266  */ uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY) /** Switches the attached HID device's reporting protocol over to the standard Report protocol mode. This also retrieves * and parses the device's HID report descriptor, so that the size of each report can be determined in advance. * * \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID * Report Parser this function references must be implemented in the user code. * \n\n * * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable. *  Dean Camera committed Jun 17, 2010 267  * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state.  Dean Camera committed May 08, 2010 268 269 270 271  * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum if an error occurs while retrieving the HID * Report descriptor or the setting of the Report protocol, \ref HID_ERROR_LOGICAL if the HID interface does * not have a valid \ref HID_ReportInfo_t structure set in its configuration, a mask of \ref HID_ERROR_LOGICAL  Dean Camera committed Jun 17, 2010 272  * and a value from the \ref HID_Parse_ErrorCodes_t otherwise.  Dean Camera committed May 08, 2010 273 274 275 276 277 278 279 280 281  */ uint8_t HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); #endif /* Inline Functions: */ /** General management task for a given Human Interface Class host class interface, required for the correct operation of * the interface. This should be called frequently in the main program loop, before the master USB management task * \ref USB_USBTask(). *  Dean Camera committed Jun 17, 2010 282  * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state.  Dean Camera committed May 08, 2010 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299  */ static inline void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo); static inline void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) { (void)HIDInterfaceInfo; } /* 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)  Dean Camera committed May 09, 2010 300 301 302  static uint8_t DCOMP_HID_Host_NextHIDInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1); static uint8_t DCOMP_HID_NextHID(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1); static uint8_t DCOMP_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 303 304 305 306 307 308 309 310 311 312 313  #endif #endif /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */