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