Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Class / Device / HID.h @ 978b99e5

History | View | Annotate | Download (12.1 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

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

    
9
/*
10
  Copyright 2011  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 USB module driver
37
 *        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
 *  \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 <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
46
 *
47
 *  \section Sec_ModDescription 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
        /* Enable C linkage for C++ Compilers: */
61
                #if defined(__cplusplus)
62
                        extern "C" {
63
                #endif
64

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

    
70
        /* Public Interface - May be used in end-application: */
71
                /* Type Defines: */
72
                        /** \brief HID Class Device Mode Configuration and State Structure.
73
                         *
74
                         *  Class state structure. An instance of this structure should be made for each HID interface
75
                         *  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
                         *  \note Due to technical limitations, the HID device class driver does not utilize a separate OUT
79
                         *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to
80
                         *        the device via the control endpoint.
81
                         */
82
                        typedef struct
83
                        {
84
                                const struct
85
                                {
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
                                        void*    PrevReportINBuffer; /**< Pointer to a buffer where the previously created HID input report can be
93
                                                                      *  stored by the driver, for comparison purposes to detect report changes that
94
                                                                      *  must be sent immediately to the host. This should point to a buffer big enough
95
                                                                      *  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
                                                                                                  *  \ref CALLBACK_HID_Device_CreateHIDReport() callback function.
98
                                                                                                  *
99
                                                                                                  *  \note Due to the single buffer, the internal driver can only correctly compare
100
                                                                                                  *        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
                                                                                                  *        by the user application instead.
103
                                                                      */
104
                                        uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a
105
                                                                          *  second buffer of the same size within the driver so that subsequent reports
106
                                                                          *  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
                                                                                                          *  set to the size of the largest report the device can issue to the host.
109
                                                                          */
110
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section
111
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
112
                                           */
113
                                struct
114
                                {
115
                                        bool     UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode. */
116
                                        uint16_t IdleCount; /**< Report idle period, in milliseconds, set by the host. */
117
                                        uint16_t IdleMSRemaining; /**< Total number of milliseconds remaining before the idle period elapsed - this
118
                                                                                           *   should be decremented by the user application if non-zero each millisecond. */
119
                                } State; /**< State data for the USB class interface within the device. All elements in this section
120
                                          *   are reset to their defaults when the interface is enumerated.
121
                                          */
122
                        } USB_ClassInfo_HID_Device_t;
123

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

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

    
142
                        /** General management task for a given HID class interface, required for the correct operation of the interface. This should
143
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
144
                         *
145
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
146
                         */
147
                        void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
148

    
149
                        /** HID class driver callback for the user creation of a HID IN report. This callback may fire in response to either
150
                         *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the
151
                         *  user is responsible for the creation of the next HID input report to be sent to the host.
152
                         *
153
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
154
                         *  \param[in,out] ReportID          If preset to a non-zero value, this is the report ID being requested by the host. If zero,
155
                         *                                   this should be set to the report ID of the generated HID input report (if any). If multiple
156
                         *                                   reports are not sent via the given HID interface, this parameter should be ignored.
157
                         *  \param[in]     ReportType        Type of HID report to generate, either \ref HID_REPORT_ITEM_In or \ref HID_REPORT_ITEM_Feature.
158
                         *  \param[out]    ReportData        Pointer to a buffer where the generated HID report should be stored.
159
                         *  \param[out]    ReportSize        Number of bytes in the generated input report, or zero if no report is to be sent.
160
                         *
161
                         *  \return Boolean \c true to force the sending of the report even if it is identical to the previous report and still within
162
                         *          the idle period (useful for devices which report relative movement), \c false otherwise.
163
                         */
164
                        bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
165
                                                                 uint8_t* const ReportID,
166
                                                                 const uint8_t ReportType,
167
                                                                 void* ReportData,
168
                                                                 uint16_t* const ReportSize) ATTR_NON_NULL_PTR_ARG(1)
169
                                                                 ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(4) ATTR_NON_NULL_PTR_ARG(5);
170

    
171
                        /** HID class driver callback for the user processing of a received HID OUT report. This callback may fire in response to
172
                         *  either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback
173
                         *  the user is responsible for the processing of the received HID output report from the host.
174
                         *
175
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
176
                         *  \param[in]     ReportID          Report ID of the received output report. If multiple reports are not received via the given HID
177
                         *                                   interface, this parameter should be ignored.
178
                         *  \param[in]     ReportType        Type of received HID report, either \ref HID_REPORT_ITEM_Out or \ref HID_REPORT_ITEM_Feature.
179
                         *  \param[in]     ReportData        Pointer to a buffer where the received HID report is stored.
180
                         *  \param[in]     ReportSize        Size in bytes of the received report from the host.
181
                         */
182
                        void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
183
                                                                  const uint8_t ReportID,
184
                                                                  const uint8_t ReportType,
185
                                                                  const void* ReportData,
186
                                                                  const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(4);
187

    
188
                /* Inline Functions: */
189
                        /** Indicates that a millisecond of idle time has elapsed on the given HID interface, and the interface's idle count should be
190
                         *  decremented. This should be called once per millisecond so that hardware key-repeats function correctly. It is recommended
191
                         *  that this be called by the \ref EVENT_USB_Device_StartOfFrame() event, once SOF events have been enabled via
192
                         *  \ref USB_Device_EnableSOFEvents().
193
                         *
194
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
195
                         */
196
                        static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
197
                        static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
198
                        {
199
                                if (HIDInterfaceInfo->State.IdleMSRemaining)
200
                                  HIDInterfaceInfo->State.IdleMSRemaining--;
201
                        }
202

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

    
208
#endif
209

    
210
/** @} */
211