LUFA/Drivers/USB/Class/Host/HID.h

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