HIDClassDevice.h 12 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2012.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
10
  Copyright 2012  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
17
18
  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
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
  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.
*/

/** \file
 *  \brief Device mode driver for the library USB HID Class driver.
 *
 *  Device mode driver for the library USB HID Class driver.
 *
36
37
 *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
 *        dispatch header located in LUFA/Drivers/USB.h.
38
39
40
 */

/** \ingroup Group_USBClassHID
41
 *  \defgroup Group_USBClassHIDDevice HID Class Device Mode Driver
42
43
44
 *
 *  \section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
45
 *    - LUFA/Drivers/USB/Class/Device/HIDClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
46
 *
47
 *  \section Sec_ModDescription Module Description
48
49
50
51
 *  Device Mode USB Class driver framework interface, for the HID USB Class driver.
 *
 *  @{
 */
52

53
54
55
56
57
#ifndef _HID_CLASS_DEVICE_H_
#define _HID_CLASS_DEVICE_H_

	/* Includes: */
		#include "../../USB.h"
58
		#include "../Common/HIDClassCommon.h"
59
60
61
62
63
64
65
66

	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_HID_DRIVER)
67
			#error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
68
69
70
71
72
73
74
75
		#endif

	/* Public Interface - May be used in end-application: */
		/* Type Defines: */
			/** \brief HID Class Device Mode Configuration and State Structure.
			 *
			 *  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
76
			 *  \c HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.
77
78
79
80
81
82
83
84
85
			 *
			 *  \note Due to technical limitations, the HID device class driver does not utilize a separate OUT
			 *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to
			 *        the device via the control endpoint.
			 */
			typedef struct
			{
				const struct
				{
86
					uint8_t  InterfaceNumber; /**< Interface number of the HID interface within the device. */
87

88
					uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint. */
89
					uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint. */
90
					bool     ReportINEndpointDoubleBank; /**< Indicates if the HID interface's IN report endpoint should use double banking. */
91

92
93
94
95
					void*    PrevReportINBuffer; /**< Pointer to a buffer where the previously created HID input report can be
					                              *  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
					                              *  to hold the largest HID input report sent from the HID interface. If this is set
96
												  *  to \c NULL, it is up to the user to force transfers when needed in the
97
98
99
100
												  *  \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,
101
												  *        this buffer should be set to \c NULL and the decision to send reports made
102
103
104
105
106
												  *        by the user application instead.
					                              */
					uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a
					                                  *  second buffer of the same size within the driver so that subsequent reports
					                                  *  can be compared. If the user app is to determine when reports are to be sent
107
					                                  *  exclusively (i.e. \ref PrevReportINBuffer is \c NULL) this value must still be
108
109
110
111
													  *  set to the size of the largest report the device can issue to the host.
					                                  */
				} Config; /**< Config data for the USB class interface within the device. All elements in this section
				           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
112
				           */
113
114
				struct
				{
115
					bool     UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode. */
116
					uint16_t PrevFrameNum; /**< Frame number of the previous HID report packet opportunity. */
117
					uint16_t IdleCount; /**< Report idle period, in milliseconds, set by the host. */
118
119
					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. */
120
121
122
123
				} State; /**< State data for the USB class interface within the device. All elements in this section
				          *   are reset to their defaults when the interface is enumerated.
				          */
			} USB_ClassInfo_HID_Device_t;
124

125
126
127
128
129
		/* Function Prototypes: */
			/** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library
			 *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
			 *  containing the given HID interface is selected.
			 *
130
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
131
			 *
132
			 *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
133
			 */
134
			bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
135

136
			/** Processes incoming control requests from the host, that are directed to the given HID class interface. This should be
137
			 *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
138
			 *
139
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
140
			 */
141
			void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
142
143
144
145

			/** 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().
			 *
146
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
147
			 */
148
			void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
149

150
151
152
153
			/** HID class driver callback for the user creation of a HID IN report. This callback may fire in response to 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 creation of the next HID input report to be sent to the host.
			 *
154
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
155
			 *  \param[in,out] ReportID          If preset to a non-zero value, this is the report ID being requested by the host. If zero,
156
157
			 *                                   this should be set to the report ID of the generated HID input report (if any). If multiple
			 *                                   reports are not sent via the given HID interface, this parameter should be ignored.
158
			 *  \param[in]     ReportType        Type of HID report to generate, either \ref HID_REPORT_ITEM_In or \ref HID_REPORT_ITEM_Feature.
159
160
			 *  \param[out]    ReportData        Pointer to a buffer where the generated HID report should be stored.
			 *  \param[out]    ReportSize        Number of bytes in the generated input report, or zero if no report is to be sent.
161
			 *
162
163
			 *  \return Boolean \c 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), \c false otherwise.
164
			 */
165
166
167
168
169
			bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
			                                         uint8_t* const ReportID,
			                                         const uint8_t ReportType,
			                                         void* ReportData,
			                                         uint16_t* const ReportSize) ATTR_NON_NULL_PTR_ARG(1)
170
			                                         ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(4) ATTR_NON_NULL_PTR_ARG(5);
171

172
173
174
175
			/** HID class driver callback for the user processing of a received HID OUT report. This callback may fire in response to
			 *  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.
			 *
176
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
177
178
			 *  \param[in]     ReportID          Report ID of the received output report. If multiple reports are not received via the given HID
			 *                                   interface, this parameter should be ignored.
179
			 *  \param[in]     ReportType        Type of received HID report, either \ref HID_REPORT_ITEM_Out or \ref HID_REPORT_ITEM_Feature.
180
181
			 *  \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.
182
			 */
183
184
185
186
187
			void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
			                                          const uint8_t ReportID,
			                                          const uint8_t ReportType,
			                                          const void* ReportData,
			                                          const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(4);
188
189
190
191
192

		/* Inline Functions: */
			/** Indicates that a millisecond of idle time has elapsed on the given HID interface, and the interface's idle count should be
			 *  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
193
			 *  \ref USB_Device_EnableSOFEvents().
194
			 *
195
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
196
			 */
197
198
			static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
			static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
199
200
201
202
			{
				if (HIDInterfaceInfo->State.IdleMSRemaining)
				  HIDInterfaceInfo->State.IdleMSRemaining--;
			}
203

204
205
206
207
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
208

209
210
211
#endif

/** @} */
212