projects / pub / lufa.git / blob
? search:


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