-
Notifications
You must be signed in to change notification settings - Fork 14
/
hidapi.h
287 lines (227 loc) · 10 KB
/
hidapi.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/*******************************************************
HIDAPI - Multi-Platform library for
communication with HID devices.
Alan Ott
Signal 11 Software
8/22/2009
Copyright 2009, All Rights Reserved.
This software may be used by anyone for any reason so
long as this copyright notice remains intact.
********************************************************/
#include <wchar.h>
#ifdef _WIN32
#define HID_API_EXPORT __declspec(dllexport)
#define HID_API_CALL _stdcall
#else
#define HID_API_EXPORT
#define HID_API_CALL
#endif
#define HID_API_EXPORT_CALL HID_API_EXPORT HID_API_CALL
#ifdef __cplusplus
extern "C" {
#endif
struct hid_device_;
typedef struct hid_device_ hid_device;
struct hid_device_info {
/** Platform-specific device path */
char *path;
/** Device Vendor ID */
unsigned short vendor_id;
/** Device Product ID */
unsigned short product_id;
/** Serial Number */
wchar_t *serial_number;
/** Manufacturer String */
wchar_t *manufacturer_string;
/** Product string */
wchar_t *product_string;
/** Pointer to the next device */
struct hid_device_info *next;
};
/** Enumerate the HID Devices.
This function returns a linked list of all the HID devices
attached to the system which match vendor_id and product_id.
If vendor_id and product_id are both set to 0, then all HID
devices will be returned.
Params:
vendor_id: The Vendor ID (VID) of the types of device to open.
product_id: The Product ID (PID) of the types of device to open.
Return:
This function returns a pointer to a linked list of type
struct hid_device, containing information about the HID devices
attached to the system, or NULL in the case of failure. Free
this linked list by calling hid_free_enumeration().
*/
struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id);
/** Free an enumeration Linked List
This function frees a linked list created by hid_enumerate().
Params:
devs: Pointer to a list of struct_device returned from
hid_enumerate().
Return:
This function does not return a value.
*/
void HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs);
/** Open a HID device using a Vendor ID (VID), Product ID (PID) and
optionally a serial number. If serial_number is NULL, the first
device with the specified VID and PID is opened.
Params:
vendor_id: The Vendor ID (VID) of the device to open.
product_id: The Product ID (PID) of the device to open.
serial_number: The Serial Number of the device to open
(Optionally NULL).
Return:
This function returns a pointer to a hid_device object on
success or NULL on failure.
*/
HID_API_EXPORT hid_device * HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, wchar_t *serial_number);
/** Open a HID device by its path name. The path name be determined
by calling hid_enumerate(), or a platform-specific path name can
be used (eg: /dev/hidraw0 on Linux).
Params:
path: The path name of the device to open
Return:
This function returns a pointer to a hid_device object on
success or NULL on failure.
*/
HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path);
/** Write an Output report to a HID device. The first byte of data[]
must contain the Report ID. For devices which only support a single
report, this must be set to 0x0. The remaining bytes contain the
report data. Since the Report ID is mandatory, calls to hid_write()
will always contain one more byte than the report contains. For
example, if a hid report is 16 bytes long, 17 bytes must be passed
to hid_write(), the Report ID (or 0x0, for devices with a single
report), followed by the report data (16 bytes). In this example,
the length passed in would be 17.
hid_write() will send the data on the first OUT endpoint, if one
exists. If it does not, it will send the data through the Control
Endpoint (Endpoint 0).
Params:
device: A device handle returned from hid_open().
data: The data to send, including the report number as
the first byte.
length: The length in bytes of the data to send.
Return Value:
This function returns the actual number of bytes written and
-1 on error.
*/
int HID_API_EXPORT HID_API_CALL hid_write(hid_device *device, const unsigned char *data, size_t length);
/** Read an Input report from a HID device. Input reports are returned
to the host through the INTERRUPT IN endpoint. The first byte will
contain the Report number if the device uses numbered reports.
Params:
device: A device handle returned from hid_open().
data: A buffer to put the read data into.
length: The number of bytes to read. For devices with multiple
reports, make sure to read an extra byte for the
report number.
Return Value:
This function returns the actual number of bytes read and
-1 on error.
*/
int HID_API_EXPORT HID_API_CALL hid_read(hid_device *device, unsigned char *data, size_t length);
/** Set the device handle to be non-blocking. In non-blocking mode
calls to hid_read() will return immediately with a value of 0
if there is no data to be read. In blocking mode, hid_read()
will wait (block) until there is data to read before returning.
Nonblocking can be turned on and off at any time.
Params:
device: A device handle returned from hid_open().
nonblock: 1 to enable nonblocking or 0 to disable
nonblocking.
Return Value:
This function returns 0 on success and -1 on error.
*/
int HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *device, int nonblock);
/** Send a Feature report to the device. Feature reports are sent
over the Control endpoint as a Set_Report transfer. The first
byte of data[] must contain the Report ID. For devices which only
support a single report, this must be set to 0x0. The remaining
bytes contain the report data. Since the Report ID is mandatory,
calls to hid_send_feature_report() will always contain one more
byte than the report contains. For example, if a hid report is 16
bytes long, 17 bytes must be passed to hid_send_feature_report():
the Report ID (or 0x0, for devices which do not use numbered
reports), followed by the report data (16 bytes). In this example,
the length passed in would be 17.
Params:
device: A device handle returned from hid_open().
data: The data to send, including the report number as
the first byte.
length: The length in bytes of the data to send, including
the report number.
Return Value:
This function returns the actual number of bytes written and
-1 on error.
*/
int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *device, const unsigned char *data, size_t length);
/** Get a feature report from a HID device. Make sure to set the
first byte of data[] to the Report ID of the report to be read.
Make sure to allow space for this extra byte in data[].
Params:
device: A device handle returned from hid_open().
data: A buffer to put the read data into, including the
Report ID. Set the first byte of data[] to the Report
ID of the report to be read.
length: The number of bytes to read, including an extra byte
for the report ID. The buffer can be longer than the
actual report.
Return Value:
This function returns the number of bytes read and
-1 on error.
*/
int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *device, unsigned char *data, size_t length);
/** Close a HID device.
Params:
device: A device handle returned from hid_open().
*/
void HID_API_EXPORT HID_API_CALL hid_close(hid_device *device);
/** Get The Manufacturer String from a HID device.
Params:
device: A device handle returned from hid_open().
string: A wide string buffer to put the data into.
maxlen: The length of the buffer in multiples of wchar_t.
Return Value:
This function returns 0 on success and -1 on error.
*/
int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *device, wchar_t *string, size_t maxlen);
/** Get The Product String from a HID device.
Params:
device: A device handle returned from hid_open().
string: A wide string buffer to put the data into.
maxlen: The length of the buffer in multiples of wchar_t.
Return Value:
This function returns 0 on success and -1 on error.
*/
int HID_API_EXPORT_CALL hid_get_product_string(hid_device *device, wchar_t *string, size_t maxlen);
/** Get The Serial Number String from a HID device.
Params:
device: A device handle returned from hid_open().
string: A wide string buffer to put the data into.
maxlen: The length of the buffer in multiples of wchar_t.
Return Value:
This function returns 0 on success and -1 on error.
*/
int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *device, wchar_t *string, size_t maxlen);
/** Get a string from a HID device, based on its string index.
Params:
device: A device handle returned from hid_open().
string_index: The index of the string to get.
string: A wide string buffer to put the data into.
maxlen: The length of the buffer in multiples of wchar_t.
Return Value:
This function returns 0 on success and -1 on error.
*/
int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *device, int string_index, wchar_t *string, size_t maxlen);
/** Get a string describing the last error which occurred.
Params:
device: A device handle returned from hid_open().
Return Value:
This function returns a string containing the last error
which occurred or NULL if none has occurred.
*/
HID_API_EXPORT const wchar_t* HID_API_CALL hid_error(hid_device *device);
#ifdef __cplusplus
}
#endif