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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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_USBClassHIDDevice HID Class Device 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/Device/HID.c
  37  *
  38  *  \section Module Description
  39  *  Device Mode USB Class driver framework interface, for the HID USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef _HID_CLASS_DEVICE_H_
  45 #define _HID_CLASS_DEVICE_H_
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/HID.h"
  50
  51                 #include <string.h>
  52
  53         /* Enable C linkage for C++ Compilers: */
  54                 #if defined(__cplusplus)
  55                         extern "C" {
  56                 #endif
  57
  58         /* Public Interface - May be used in end-application: */
  59                 /* Type Defines: */
  60                         /** Class state structure. An instance of this structure should be made for each HID interface
  61                          *  within the user application, and passed to each of the HID class driver functions as the
  62                          *  HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.
  63                          *
  64                          *  \note Due to technical limitations, the HID device class driver does not utilize a separate OUT
  65                          *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to
  66                          *        the device via the control endpoint.
  67                          */
  68                         typedef struct
  69                         {
  70                                 const struct
  71                                 {
  72                                         uint8_t  InterfaceNumber; /**< Interface number of the HID interface within the device */
  73
  74                                         uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */
  75                                         uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */
  76                                         bool     ReportINEndpointDoubleBank; /** Indicates if the HID interface's IN report endpoint should use double banking */
  77
  78                                         void*    PrevReportINBuffer; /**< Pointer to a buffer where the previously created HID input report can be
  79                                                                       *  stored by the driver, for comparison purposes to detect report changes that
  80                                                                       *  must be sent immediately to the host. This should point to a buffer big enough
  81                                                                       *  to hold the largest HID input report sent from the HID interface. If this is set
  82                                                                                                   *  to NULL, it is up to the user to force transfers when needed in the
  83                                                                                                   *  \ref CALLBACK_HID_Device_CreateHIDReport() callback function.
  84                                                                                                   *
  85                                                                                                   *  \note Due to the single buffer, the internal driver can only correctly compare
  86                                                                                                   *        subsequent reports with identical report IDs. In multiple report devices,
  87                                                                                                   *        this buffer should be set to NULL and the decision to send reports made
  88                                                                                                   *        by the user application instead.
  89                                                                       */
  90                                         uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a
  91                                                                           *  second buffer of the same size within the driver so that subsequent reports
  92                                                                           *  can be compared.
  93                                                                           */
  94                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  95                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  96                                            */
  97                                 struct
  98                                 {
  99                                         bool     UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */
 100                                         uint16_t IdleCount; /**< Report idle period, in milliseconds, set by the host */
 101                                         uint16_t IdleMSRemaining; /**< Total number of milliseconds remaining before the idle period elapsed - this
 102                                                                                            *   should be decremented by the user application if non-zero each millisecond */
 103                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 104                                           *   are reset to their defaults when the interface is enumerated.
 105                                           */
 106                         } USB_ClassInfo_HID_Device_t;
 107
 108                 /* Function Prototypes: */
 109                         /** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library
 110                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
 111                          *  containing the given HID interface is selected.
 112                          *
 113                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 114                          *
 115                          *  \return Boolean true if the endpoints were successfully configured, false otherwise
 116                          */
 117                         bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 118
 119                         /** Processes incoming control requests from the host, that are directed to the given HID class interface. This should be
 120                          *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
 121                          *
 122                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 123                          */
 124                         void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 125
 126                         /** General management task for a given HID class interface, required for the correct operation of the interface. This should
 127                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 128                          *
 129                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 130                          */
 131                         void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 132
 133                         /** Indicates that a millisecond of idle time has elapsed on the given HID interface, and the interface's idle count should be
 134                          *  decremented. This should be called once per millisecond so that hardware key-repeats function correctly. It is recommended
 135                          *  that this be called by the \ref EVENT_USB_Device_StartOfFrame() event, once SOF events have been enabled via
 136                          *  \ref USB_Device_EnableSOFEvents();.
 137                          *
 138                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 139                          */
 140                         void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 141
 142                         /** HID class driver callback for the user creation of a HID IN report. This callback may fire in response to either
 143                          *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the
 144                          *  user is responsible for the creation of the next HID input report to be sent to the host.
 145                          *
 146                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 147                          *  \param[in,out] ReportID  If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should
 148                          *                 be set to the report ID of the generated HID input report (if any). If multiple reports are not sent via the
 149                          *                 given HID interface, this parameter should be ignored.
 150                          *  \param[in] ReportType  Type of HID report to generate, either \ref REPORT_ITEM_TYPE_In or \ref REPORT_ITEM_TYPE_Feature
 151                          *  \param[out] ReportData  Pointer to a buffer where the generated HID report should be stored
 152                          *  \param[out] ReportSize  Number of bytes in the generated input report, or zero if no report is to be sent
 153                          *
 154                          *  \return Boolean true to force the sending of the report even if it is identical to the previous report and still within
 155                          *          the idle period (useful for devices which report relative movement), false otherwise
 156                          */
 157                         bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 158                                                      const uint8_t ReportType, void* ReportData, uint16_t* ReportSize) ATTR_NON_NULL_PTR_ARG(1)
 159                                                                  ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(4) ATTR_NON_NULL_PTR_ARG(5);
 160
 161                         /** HID class driver callback for the user processing of a received HID OUT report. This callback may fire in response to
 162                          *  either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback
 163                          *  the user is responsible for the processing of the received HID output report from the host.
 164                          *
 165                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 166                          *  \param[in] ReportID  Report ID of the received output report. If multiple reports are not received via the given HID
 167                          *                   interface, this parameter should be ignored.
 168                          *  \param[in] ReportData  Pointer to a buffer where the received HID report is stored.
 169                          *  \param[in] ReportSize  Size in bytes of the received report from the host.
 170                          */
 171                         void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 172                                                                   const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)
 173                                                                   ATTR_NON_NULL_PTR_ARG(3);
 174
 175         /* Disable C linkage for C++ Compilers: */
 176                 #if defined(__cplusplus)
 177                         }
 178                 #endif
 179
 180 #endif
 181
 182 /** @} */