HIDClassHost.h 16.8 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 Host mode driver for the library USB HID Class driver.
 *
 *  Host 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_USBClassHIDHost HID Class Host 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/Host/HIDClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
46
 *
47
 *  \section Sec_ModDescription Module Description
48
49
50
51
52
53
54
55
56
57
 *  Host Mode USB Class driver framework interface, for the HID USB Class driver.
 *
 *  @{
 */

#ifndef __HID_CLASS_HOST_H__
#define __HID_CLASS_HOST_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
		#endif

	/* Public Interface - May be used in end-application: */
		/* Macros: */
Dean Camera's avatar
Dean Camera committed
72
			/** Error code for some HID Host functions, indicating a logical (and not hardware) error. */
73
			#define HID_ERROR_LOGICAL              0x80
74

75
76
77
78
		/* Type Defines: */
			/** \brief HID Class Host Mode Configuration and State Structure.
			 *
			 *  Class state structure. An instance of this structure should be made within the user application,
79
			 *  and passed to each of the HID class driver functions as the \c HIDInterfaceInfo parameter. This
80
81
82
83
			 *  stores each HID interface's configuration and state information.
			 */
			typedef struct
			{
84
				struct
85
				{
86
87
					uint8_t  DataINPipeNumber; /**< Pipe number of the HID interface's IN data pipe. */
					bool     DataINPipeDoubleBank; /**< Indicates if the HID interface's IN data pipe should use double banking. */
88

89
90
					uint8_t  DataOUTPipeNumber; /**< Pipe number of the HID interface's OUT data pipe. */
					bool     DataOUTPipeDoubleBank; /**< Indicates if the HID interface's OUT data pipe should use double banking. */
91
92

					uint8_t  HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific
93
94
					                                *   boot subclass protocol is required, a protocol value from the
					                                *   \ref HID_Descriptor_ClassSubclassProtocol_t enum.
95
96
97
					                                */
					#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
					HID_ReportInfo_t* HIDParserData; /**< HID parser data to store the parsed HID report data, when boot protocol
98
					                                  *   is not used.
99
													  *
100
					                                  *  \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined,
101
102
103
104
105
106
107
108
109
110
					                                  *        this method is unavailable.
					                                  */
					#endif
				} 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.
				           */
				struct
				{
					bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
					                *   after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the
111
					                *   Configured state.
112
					                */
113
					uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device. */
114

115
116
					uint16_t DataINPipeSize; /**< Size in bytes of the HID interface's IN data pipe. */
					uint16_t DataOUTPipeSize;  /**< Size in bytes of the HID interface's OUT data pipe. */
117

118
					bool SupportsBootProtocol; /**< Indicates if the current interface instance supports the HID Boot
119
					                            *   Protocol when enabled via \ref HID_Host_SetBootProtocol().
120
121
122
123
124
					                            */
					bool DeviceUsesOUTPipe; /**< Indicates if the current interface instance uses a separate OUT data pipe for
					                         *   OUT reports, or if OUT reports are sent via the control pipe instead.
					                         */
					bool UsingBootProtocol; /**< Indicates that the interface is currently initialized in Boot Protocol mode */
125
					uint16_t HIDReportSize; /**< Size in bytes of the HID report descriptor in the device. */
126

127
					uint8_t LargestReportSize; /**< Largest report the device will send, in bytes. */
128
129
130
131
132
133
134
135
				} State; /**< State data for the USB class interface within the device. All elements in this section
						  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
						  *   the interface is enumerated.
						  */
			} USB_ClassInfo_HID_Host_t;

		/* Enums: */
			/** Enum for the possible error codes returned by the \ref HID_Host_ConfigurePipes() function. */
136
			enum HID_Host_EnumerationFailure_ErrorCodes_t
137
			{
138
139
				HID_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
				HID_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
140
				HID_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible HID interface was not found in the device's Configuration Descriptor. */
141
				HID_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
142
			};
143

144
145
146
147
148
149
150
151
152
153
		/* Function Prototypes: */
			/** Host interface configuration routine, to configure a given HID host interface instance using the Configuration
			 *  Descriptor read from an attached USB device. This function automatically updates the given HID Host instance's
			 *  state values and configures the pipes required to communicate with the interface if it is found within the
			 *  device. This should be called once after the stack has enumerated the attached device, while the host state
			 *  machine is in the Addressed state.
			 *
			 *  \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
			 *        to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
			 *
154
155
156
			 *  \param[in,out] HIDInterfaceInfo      Pointer to a structure containing a HID Class host configuration and state.
			 *  \param[in]     ConfigDescriptorSize  Length of the attached device's Configuration Descriptor.
			 *  \param[in]     ConfigDescriptorData  Pointer to a buffer containing the attached device's Configuration Descriptor.
157
			 *
158
			 *  \return A value from the \ref HID_Host_EnumerationFailure_ErrorCodes_t enum.
159
			 */
160
161
			uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
			                                uint16_t ConfigDescriptorSize,
162
			                                void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
163
164
165


			/** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe.
166
			 *
167
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
168
			 *       call will fail.
169
170
171
172
			 *
			 *  \note The destination buffer should be large enough to accommodate the largest report that the attached device
			 *        can generate.
			 *
173
174
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
			 *  \param[in]     Buffer            Buffer to store the received report into.
175
			 *
176
			 *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
177
			 */
178
179
			uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
			                               void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
180
181
182
183

			#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
			/** Receives a HID IN report from the attached device, by the report ID.
			 *
184
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
185
			 *       call will fail.
186
			 *
187
			 *  \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
188
			 *
189
190
191
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
			 *  \param[in]     ReportID          Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch.
			 *  \param[in]     Buffer            Buffer to store the received report into.
192
			 *
193
			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
194
			 */
195
196
			uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
			                                   const uint8_t ReportID,
197
198
			                                   void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
			#endif
199

200
201
			/** Sends an OUT or FEATURE report to the currently attached HID device, using the device's OUT pipe if available,
			 *  or the device's Control pipe if not.
202
			 *
203
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
204
			 *       call will fail.
205
			 *
206
			 *  \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed
207
208
			 *        from the parameter list of this function.
			 *
209
210
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
			 *  \param[in]     ReportID          Report ID of the report to send to the device, or 0 if the device does not use report IDs.
211
			 *  \param[in]     ReportType        Type of report to issue to the device, either \ref HID_REPORT_ITEM_Out or \ref HID_REPORT_ITEM_Feature.
212
213
			 *  \param[in]     Buffer            Buffer containing the report to send to the attached device.
			 *  \param[in]     ReportSize        Report size in bytes to send to the attached device.
214
215
			 *
			 *  \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in
216
			 *          the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise.
217
218
219
220
221
			 */
			uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
			#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
			                                const uint8_t ReportID,
			#endif
222
223
224
			                                const uint8_t ReportType,
			                                void* Buffer,
			                                const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)
225
			#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
226
			                                ATTR_NON_NULL_PTR_ARG(4);
227
			#else
228
			                                ATTR_NON_NULL_PTR_ARG(3);
229
230
231
232
			#endif

			/** Determines if a HID IN report has been received from the attached device on the data IN pipe.
			 *
233
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
234
			 *       call will fail.
235
			 *
236
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
237
			 *
238
			 *  \return Boolean \c true if a report has been received, \c false otherwise.
239
240
			 */
			bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
241

242
243
			/** Switches the attached HID device's reporting protocol over to the Boot Report protocol mode, on supported devices.
			 *
244
			 *  \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method must still be called
245
246
			 *        to explicitly place the attached device into boot protocol mode before use.
			 *
247
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
248
249
			 *
			 *  \return \ref HID_ERROR_LOGICAL if the device does not support Boot Protocol mode, a value from the
250
			 *          \ref USB_Host_SendControlErrorCodes_t enum otherwise.
251
252
253
			 */
			uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

254
255
256
257
			/** Sets the idle period for the attached HID device to the specified interval. The HID idle period determines the rate
			 *  at which the device should send a report, when no state changes have ocurred; i.e. on HID keyboards, this sets the
			 *  hardware key repeat interval.
			 *
258
259
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
			 *  \param[in]     MS                Idle period as a multiple of four milliseconds, zero to disable hardware repeats
260
261
262
			 *
			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
			 */
263
			uint8_t HID_Host_SetIdlePeriod(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
264
			                               const uint16_t MS) ATTR_NON_NULL_PTR_ARG(1);
265

266
267
268
269
270
271
272
273
			#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
			/** Switches the attached HID device's reporting protocol over to the standard Report protocol mode. This also retrieves
			 *  and parses the device's HID report descriptor, so that the size of each report can be determined in advance.
			 *
			 *  \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID
			 *        Report Parser this function references <b>must</b> be implemented in the user code.
			 *        \n\n
			 *
274
			 *  \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
275
			 *
276
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
277
278
279
280
			 *
			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum if an error occurs while retrieving the HID
			 *          Report descriptor or the setting of the Report protocol, \ref HID_ERROR_LOGICAL if the HID interface does
			 *          not have a valid \ref HID_ReportInfo_t structure set in its configuration, a mask of \ref HID_ERROR_LOGICAL
281
			 *          and a value from the \ref HID_Parse_ErrorCodes_t otherwise.
282
283
284
			 */
			uint8_t HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
			#endif
285

286
287
288
289
290
		/* Inline Functions: */
			/** General management task for a given Human Interface Class host 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().
			 *
291
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
292
			 */
Dean Camera's avatar
Dean Camera committed
293
			static inline void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
294
295
296
			static inline void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)
			{
				(void)HIDInterfaceInfo;
297
			}
298
299
300
301

	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Function Prototypes: */
302
			#if defined(__INCLUDE_FROM_HID_HOST_C)
Dean Camera's avatar
Dean Camera committed
303
304
305
306
307
308
				static uint8_t DCOMP_HID_Host_NextHIDInterface(void* const CurrentDescriptor)
				                                               ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
				static uint8_t DCOMP_HID_Host_NextHIDDescriptor(void* const CurrentDescriptor)
				                                                ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
				static uint8_t DCOMP_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor)
				                                                       ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
309
310
311
			#endif
	#endif

312
313
314
315
316
317
318
319
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif

#endif

/** @} */
320