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