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