forked from gary-rowe/hid4java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHidApiLibrary.java
More file actions
284 lines (261 loc) · 11 KB
/
HidApiLibrary.java
File metadata and controls
284 lines (261 loc) · 11 KB
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
/*
* The MIT License (MIT)
*
* Copyright (c) 2014-2015 Gary Rowe
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
package org.hid4java.jna;
/**
* <p>[Pattern] to provide the following to {@link Object}:</p>
* <ul>
* <li></li>
* </ul>
* <p>Example:</p>
* <pre>
* </pre>
*
* @since 0.0.1
*
*/
import com.sun.jna.Library;
import com.sun.jna.Native;
import com.sun.jna.Pointer;
import com.sun.jna.WString;
/**
* <p>JNA library interface to act as the proxy for the underlying native library</p>
* <p>This approach removes the need for any JNI or native code</p>
*/
public interface HidApiLibrary extends Library {
HidApiLibrary INSTANCE = (HidApiLibrary) Native.loadLibrary("hidapi", HidApiLibrary.class);
/**
* <p>Initialize the HIDAPI library.</p>
* <p>This function initializes the HIDAPI library. Calling it is not strictly necessary,
* as it will be called automatically by hid_enumerate() and any of the hid_open_*() functions
* if it is needed. This function should be called at the beginning of execution however,
* if there is a chance of HIDAPI handles being opened by different threads simultaneously.</p>
*/
void hid_init();
/**
* <p>Finalize the HIDAPI library.</p>
*
* <p>This function frees all of the static data associated with HIDAPI. It should be called
* at the end of execution to avoid memory leaks.</p>
*/
void hid_exit();
/**
* 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.
*
* @param vendor_id The vendor ID
* @param product_id The product ID
* @param serial_number The serial number (or null for wildcard)
*
* @return A pointer to a HidDevice on success or null on failure
*/
Pointer hid_open(short vendor_id, short product_id, WString serial_number);
/**
* Close a HID device
*
* @param device A device handle
*/
void hid_close(Pointer device);
/**
* Get a string describing the last error which occurred.
*
* @param device A device handle
*
* @return A string containing the last error which occurred or null if none has occurred.
*/
Pointer hid_error(Pointer device);
/**
* 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.
*
* @param device A device handle returned from hid_open().
* @param bytes A buffer to put the read data into.
* @param length The number of bytes to read. For devices with multiple reports, make sure to read an extra byte for the report number.
*
* @return This function returns the actual number of bytes read and -1 on error. If no packet was available to be read
* and the handle is in non-blocking mode this function returns 0.
*/
int hid_read(Pointer device, WideStringBuffer.ByReference bytes, int length);
/**
* Read an Input report from a HID device with timeout.
*
* 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.
*
* @param device A device handle
* @param bytes A buffer to put the read data into.
* @param length The number of bytes to read. For devices with multiple reports, make sure to read an extra byte for the report number.
* @param timeout The timeout in milliseconds or -1 for blocking wait.
*
* @return This function returns the actual number of bytes read and -1 on error. If no packet was available to be read within
* the timeout period, this function returns 0.
*/
int hid_read_timeout(Pointer device, WideStringBuffer.ByReference bytes, int length, int timeout);
/**
* 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).
*
* @param device A device handle
* @param data the data to send, including the report number as the first byte
* @param len The length in bytes of the data to send
*
* @return The actual number of bytes written, -1 on error
*/
int hid_write(Pointer device, WideStringBuffer.ByReference data, int len);
/**
* Get a feature report from a HID device.
*
* 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[].
* Upon return, the first byte will still contain the Report ID, and the report data will start in data[1].
*
* @param device A device handle
* @param 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, or set it to zero if your device does not use numbered reports.
* @param 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 The number of bytes read plus one for the report ID (which is still in the first byte), or -1 on error
*/
int hid_get_feature_report(Pointer device, WideStringBuffer.ByReference data, int length);
/**
* 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.
*
* @param device The device handle
* @param data The data to send, including the report number as the first byte
* @param length The length inbytes of the data to send, including the report number
*
* @return The actual number of bytes written, -1 on error
*/
int hid_send_feature_report(Pointer device, WideStringBuffer.ByReference data, int length);
/**
* Get a string from a HID device, based on its string index.
*
* @param device the device handle
* @param idx The index of the string to get
* @param string A wide string buffer to put the data into
* @param len The length of the buffer in multiples of wchar_t
*
* @return 0 on success, -1 on failure
*/
int hid_get_indexed_string(Pointer device, int idx, WideStringBuffer.ByReference string, int len);
/**
* Get the manufacturer string from a HID device
*
* @param device the device handle
* @param str A wide string buffer to put the data into
* @param len The length of the buffer in multiple of wchar_t
*
* @return 0 on success, -1 on failure
*/
int hid_get_manufacturer_string(Pointer device, WideStringBuffer.ByReference str, int len);
/**
* Get the product number string from a HID device
*
* @param device the device handle
* @param str A wide string buffer to put the data into
* @param len The length of the buffer in multiple of wchar_t
*
* @return 0 on success, -1 on failure
*/
int hid_get_product_string(Pointer device, WideStringBuffer.ByReference str, int len);
/**
* Get the serial number string from a HID device
*
* @param device the device handle
* @param str A wide string buffer to put the data into
* @param len The length of the buffer in multiple of wchar_t
*
* @return 0 on success, -1 on failure
*/
int hid_get_serial_number_string(Pointer device, WideStringBuffer.ByReference str, int len);
/**
* 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.
*
* @param device The device handle
* @param nonblock 0 disables non-blocking, 1 enables non-blocking
*
* @return 0 on success, -1 on error
*/
int hid_set_nonblocking(Pointer device, int nonblock);
/**
* 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 is set to 0 then any vendor matches. If product_id is set to 0 then any product matches.
*
* If vendor_id and product_id are both set to 0, then all HID devices will be returned.
*
* @param vendor_id The vendor ID
* @param product_id The product ID
*
* @return A linked list of all discovered matching devices
*/
HidDeviceInfoStructure hid_enumerate(short vendor_id, short product_id);
/**
* Free an enumeration linked list
*
* @param devs The device information pointer
*/
void hid_free_enumeration(Pointer devs);
/**
* 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).
*
* @param path The path name
*
* @return The pointer if successful or null
*/
Pointer hid_open_path(String path);
}