LUFA/Drivers/USB/Class/Device/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_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         /* 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                 /* Type Defines: */
  65                         /** Class state structure. An instance of this structure should be made for each HID interface
  66                          *  within the user application, and passed to each of the HID class driver functions as the
  67                          *  HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.
  68                          *
  69                          *  \note Due to technical limitations, the HID device class driver does not utilize a separate OUT
  70                          *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to
  71                          *        the device via the control endpoint.
  72                          */
  73                         typedef struct
  74                         {
  75                                 const struct
  76                                 {
  77                                         uint8_t  InterfaceNumber; /**< Interface number of the HID interface within the device */
  78
  79                                         uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */
  80                                         uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */
  81                                         bool     ReportINEndpointDoubleBank; /** Indicates if the HID interface's IN report endpoint should use double banking */
  82
  83                                         void*    PrevReportINBuffer; /**< Pointer to a buffer where the previously created HID input report can be
  84                                                                       *  stored by the driver, for comparison purposes to detect report changes that
  85                                                                       *  must be sent immediately to the host. This should point to a buffer big enough
  86                                                                       *  to hold the largest HID input report sent from the HID interface. If this is set
  87                                                                                                   *  to NULL, it is up to the user to force transfers when needed in the
  88                                                                                                   *  \ref CALLBACK_HID_Device_CreateHIDReport() callback function.
  89                                                                                                   *
  90                                                                                                   *  \note Due to the single buffer, the internal driver can only correctly compare
  91                                                                                                   *        subsequent reports with identical report IDs. In multiple report devices,
  92                                                                                                   *        this buffer should be set to NULL and the decision to send reports made
  93                                                                                                   *        by the user application instead.
  94                                                                       */
  95                                         uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a
  96                                                                           *  second buffer of the same size within the driver so that subsequent reports
  97                                                                           *  can be compared. If the user app is to determine when reports are to be sent
  98                                                                           *  exclusively (i.e. \ref PrevReportINBuffer is NULL) this value is ignored.
  99                                                                           */
 100                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
 101                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
 102                                            */
 103                                 struct
 104                                 {
 105                                         bool     UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */
 106                                         uint16_t IdleCount; /**< Report idle period, in milliseconds, set by the host */
 107                                         uint16_t IdleMSRemaining; /**< Total number of milliseconds remaining before the idle period elapsed - this
 108                                                                                            *   should be decremented by the user application if non-zero each millisecond */
 109                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 110                                           *   are reset to their defaults when the interface is enumerated.
 111                                           */
 112                         } USB_ClassInfo_HID_Device_t;
 113
 114                 /* Function Prototypes: */
 115                         /** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library
 116                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
 117                          *  containing the given HID interface is selected.
 118                          *
 119                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 120                          *
 121                          *  \return Boolean true if the endpoints were successfully configured, false otherwise
 122                          */
 123                         bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 124
 125                         /** Processes incoming control requests from the host, that are directed to the given HID class interface. This should be
 126                          *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
 127                          *
 128                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 129                          */
 130                         void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 131
 132                         /** General management task for a given HID class interface, required for the correct operation of the interface. This should
 133                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 134                          *
 135                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 136                          */
 137                         void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 138
 139                         /** HID class driver callback for the user creation of a HID IN report. This callback may fire in response to either
 140                          *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the
 141                          *  user is responsible for the creation of the next HID input report to be sent to the host.
 142                          *
 143                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 144                          *  \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
 145                          *                 be set to the report ID of the generated HID input report (if any). If multiple reports are not sent via the
 146                          *                 given HID interface, this parameter should be ignored.
 147                          *  \param[in] ReportType  Type of HID report to generate, either \ref REPORT_ITEM_TYPE_In or \ref REPORT_ITEM_TYPE_Feature
 148                          *  \param[out] ReportData  Pointer to a buffer where the generated HID report should be stored
 149                          *  \param[out] ReportSize  Number of bytes in the generated input report, or zero if no report is to be sent
 150                          *
 151                          *  \return Boolean true to force the sending of the report even if it is identical to the previous report and still within
 152                          *          the idle period (useful for devices which report relative movement), false otherwise
 153                          */
 154                         bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 155                                                      const uint8_t ReportType, void* ReportData, uint16_t* ReportSize) ATTR_NON_NULL_PTR_ARG(1)
 156                                                                  ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(4) ATTR_NON_NULL_PTR_ARG(5);
 157
 158                         /** HID class driver callback for the user processing of a received HID OUT report. This callback may fire in response to
 159                          *  either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback
 160                          *  the user is responsible for the processing of the received HID output report from the host.
 161                          *
 162                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 163                          *  \param[in] ReportID  Report ID of the received output report. If multiple reports are not received via the given HID
 164                          *                   interface, this parameter should be ignored.
 165                          *  \param[in] ReportData  Pointer to a buffer where the received HID report is stored.
 166                          *  \param[in] ReportSize  Size in bytes of the received report from the host.
 167                          */
 168                         void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 169                                                                   const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)
 170                                                                   ATTR_NON_NULL_PTR_ARG(3);
 171
 172                 /* Inline Functions: */
 173                         /** Indicates that a millisecond of idle time has elapsed on the given HID interface, and the interface's idle count should be
 174                          *  decremented. This should be called once per millisecond so that hardware key-repeats function correctly. It is recommended
 175                          *  that this be called by the \ref EVENT_USB_Device_StartOfFrame() event, once SOF events have been enabled via
 176                          *  \ref USB_Device_EnableSOFEvents();.
 177                          *
 178                          *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
 179                          */
 180                         static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);
 181                         static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo)
 182                         {
 183                                 if (HIDInterfaceInfo->State.IdleMSRemaining)
 184                                   HIDInterfaceInfo->State.IdleMSRemaining--;
 185                         }
 186
 187         /* Disable C linkage for C++ Compilers: */
 188                 #if defined(__cplusplus)
 189                         }
 190                 #endif
 191
 192 #endif
 193
 194 /** @} */