HID.h 11.5 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, 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 
19
20
21
22
23
24
25
26
27
28
29
30
  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.
*/

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

40
41
/** \ingroup Group_USBClassHID
 *  @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver
42
 *
43
44
45
46
 *  \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
 *
47
 *  \section Module Description
48
 *  Device Mode USB Class driver framework interface, for the HID USB Class driver.
49
50
51
52
 *
 *  @{
 */
 
53
54
#ifndef _HID_CLASS_DEVICE_H_
#define _HID_CLASS_DEVICE_H_
55
56
57

	/* Includes: */
		#include "../../USB.h"
58
		#include "../Common/HID.h"
59
60
61

		#include <string.h>

62
63
64
65
66
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

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

72
	/* Public Interface - May be used in end-application: */
73
		/* Type Defines: */
74
75
76
			/** \brief HID Class Device Mode Configuration and State Structure.
			 *
			 *  Class state structure. An instance of this structure should be made for each HID interface
77
78
			 *  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.
79
			 *
80
			 *  \note Due to technical limitations, the HID device class driver does not utilize a separate OUT
81
82
			 *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to
			 *        the device via the control endpoint.
83
84
85
			 */
			typedef struct
			{
86
87
88
89
90
				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 */
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
96
					                              *  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
97
98
99
100
101
102
103
104
					                              *  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.
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
110
					                                  *  exclusively (i.e. \ref PrevReportINBuffer is NULL) this value must still be
													  *  set to the size of the largest report the device can issue to the host.
111
					                                  */
112
113
114
115
116
117
				} 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     UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */
118
119
120
					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 */	
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
125
			} USB_ClassInfo_HID_Device_t;
	
126
127
		/* Function Prototypes: */
			/** 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
130
			 *  containing the given HID interface is selected.
			 *
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
145
146
			/** 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().
			 *
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
153
154
			 *  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.
			 *
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, this should
157
			 *                 be set to the report ID of the generated HID input report (if any). If multiple reports are not sent via the
158
			 *                 given HID interface, this parameter should be ignored.
159
160
			 *  \param[in] ReportType  Type of HID report to generate, either \ref REPORT_ITEM_TYPE_In or \ref REPORT_ITEM_TYPE_Feature
			 *  \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
164
			 *  \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
165
			 */
166
			bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
167
168
                                                     const uint8_t ReportType, void* ReportData, uint16_t* ReportSize) ATTR_NON_NULL_PTR_ARG(1)
			                                         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
172
173
			 *  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.
			 *
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
178
			 *  \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.
179
			 */
180
			void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
181
182
			                                          const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)
			                                          ATTR_NON_NULL_PTR_ARG(3);
183

184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
		/* 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
			 *  \ref USB_Device_EnableSOFEvents();.
			 *
			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
			 */
			static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);
			static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo)
			{
				if (HIDInterfaceInfo->State.IdleMSRemaining)
				  HIDInterfaceInfo->State.IdleMSRemaining--;
			}
			
199
200
201
202
203
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
		
204
#endif
205
206

/** @} */