-
Notifications
You must be signed in to change notification settings - Fork 10
/
hid_windows.c
1457 lines (1206 loc) · 40.7 KB
/
hid_windows.c
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*******************************************************
HIDAPI - Multi-Platform library for
communication with HID devices.
Alan Ott
Signal 11 Software
libusb/hidapi Team
Copyright 2022, All Rights Reserved.
At the discretion of the user of this library,
this software may be licensed under the terms of the
GNU General Public License v3, a BSD-Style license, or the
original HIDAPI license as outlined in the LICENSE.txt,
LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt
files located at the root of the source distribution.
These files may also be found in the public source
code repository located at:
https://github.com/libusb/hidapi .
********************************************************/
#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
/* Do not warn about wcsncpy usage.
https://docs.microsoft.com/cpp/c-runtime-library/security-features-in-the-crt */
#define _CRT_SECURE_NO_WARNINGS
#endif
#ifdef __cplusplus
extern "C" {
#endif
#include "hidapi_winapi.h"
#include <windows.h>
#ifndef _NTDEF_
typedef LONG NTSTATUS;
#endif
#ifdef __MINGW32__
#include <ntdef.h>
#include <winbase.h>
#define WC_ERR_INVALID_CHARS 0x00000080
#endif
#ifdef __CYGWIN__
#include <ntdef.h>
#include <wctype.h>
#define _wcsdup wcsdup
#endif
/*#define HIDAPI_USE_DDK*/
#include "hidapi_cfgmgr32.h"
#include "hidapi_hidclass.h"
#include "hidapi_hidsdi.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#ifdef MIN
#undef MIN
#endif
#define MIN(x,y) ((x) < (y)? (x): (y))
/* MAXIMUM_USB_STRING_LENGTH from usbspec.h is 255 */
/* BLUETOOTH_DEVICE_NAME_SIZE from bluetoothapis.h is 256 */
#define MAX_STRING_WCHARS 256
static struct hid_api_version api_version = {
.major = HID_API_VERSION_MAJOR,
.minor = HID_API_VERSION_MINOR,
.patch = HID_API_VERSION_PATCH
};
#ifndef HIDAPI_USE_DDK
/* Since we're not building with the DDK, and the HID header
files aren't part of the Windows SDK, we define what we need ourselves.
In lookup_functions(), the function pointers
defined below are set. */
static HidD_GetHidGuid_ HidD_GetHidGuid;
static HidD_GetAttributes_ HidD_GetAttributes;
static HidD_GetSerialNumberString_ HidD_GetSerialNumberString;
static HidD_GetManufacturerString_ HidD_GetManufacturerString;
static HidD_GetProductString_ HidD_GetProductString;
static HidD_SetFeature_ HidD_SetFeature;
static HidD_GetFeature_ HidD_GetFeature;
static HidD_GetInputReport_ HidD_GetInputReport;
static HidD_GetIndexedString_ HidD_GetIndexedString;
static HidD_GetPreparsedData_ HidD_GetPreparsedData;
static HidD_FreePreparsedData_ HidD_FreePreparsedData;
static HidP_GetCaps_ HidP_GetCaps;
static HidD_SetNumInputBuffers_ HidD_SetNumInputBuffers;
static CM_Locate_DevNodeW_ CM_Locate_DevNodeW = NULL;
static CM_Get_Parent_ CM_Get_Parent = NULL;
static CM_Get_DevNode_PropertyW_ CM_Get_DevNode_PropertyW = NULL;
static CM_Get_Device_Interface_PropertyW_ CM_Get_Device_Interface_PropertyW = NULL;
static CM_Get_Device_Interface_List_SizeW_ CM_Get_Device_Interface_List_SizeW = NULL;
static CM_Get_Device_Interface_ListW_ CM_Get_Device_Interface_ListW = NULL;
static HMODULE hid_lib_handle = NULL;
static HMODULE cfgmgr32_lib_handle = NULL;
static BOOLEAN hidapi_initialized = FALSE;
static void free_library_handles()
{
if (hid_lib_handle)
FreeLibrary(hid_lib_handle);
hid_lib_handle = NULL;
if (cfgmgr32_lib_handle)
FreeLibrary(cfgmgr32_lib_handle);
cfgmgr32_lib_handle = NULL;
}
static int lookup_functions()
{
hid_lib_handle = LoadLibraryW(L"hid.dll");
if (hid_lib_handle == NULL) {
goto err;
}
cfgmgr32_lib_handle = LoadLibraryW(L"cfgmgr32.dll");
if (cfgmgr32_lib_handle == NULL) {
goto err;
}
#if defined(__GNUC__)
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wcast-function-type"
#endif
#define RESOLVE(lib_handle, x) x = (x##_)GetProcAddress(lib_handle, #x); if (!x) goto err;
RESOLVE(hid_lib_handle, HidD_GetHidGuid);
RESOLVE(hid_lib_handle, HidD_GetAttributes);
RESOLVE(hid_lib_handle, HidD_GetSerialNumberString);
RESOLVE(hid_lib_handle, HidD_GetManufacturerString);
RESOLVE(hid_lib_handle, HidD_GetProductString);
RESOLVE(hid_lib_handle, HidD_SetFeature);
RESOLVE(hid_lib_handle, HidD_GetFeature);
RESOLVE(hid_lib_handle, HidD_GetInputReport);
RESOLVE(hid_lib_handle, HidD_GetIndexedString);
RESOLVE(hid_lib_handle, HidD_GetPreparsedData);
RESOLVE(hid_lib_handle, HidD_FreePreparsedData);
RESOLVE(hid_lib_handle, HidP_GetCaps);
RESOLVE(hid_lib_handle, HidD_SetNumInputBuffers);
RESOLVE(cfgmgr32_lib_handle, CM_Locate_DevNodeW);
RESOLVE(cfgmgr32_lib_handle, CM_Get_Parent);
RESOLVE(cfgmgr32_lib_handle, CM_Get_DevNode_PropertyW);
RESOLVE(cfgmgr32_lib_handle, CM_Get_Device_Interface_PropertyW);
RESOLVE(cfgmgr32_lib_handle, CM_Get_Device_Interface_List_SizeW);
RESOLVE(cfgmgr32_lib_handle, CM_Get_Device_Interface_ListW);
#undef RESOLVE
#if defined(__GNUC__)
# pragma GCC diagnostic pop
#endif
return 0;
err:
free_library_handles();
return -1;
}
#endif /* HIDAPI_USE_DDK */
struct hid_device_ {
HANDLE device_handle;
BOOL blocking;
USHORT output_report_length;
unsigned char *write_buf;
size_t input_report_length;
USHORT feature_report_length;
unsigned char *feature_buf;
wchar_t *last_error_str;
BOOL read_pending;
char *read_buf;
OVERLAPPED ol;
OVERLAPPED write_ol;
struct hid_device_info* device_info;
};
static hid_device *new_hid_device()
{
hid_device *dev = (hid_device*) calloc(1, sizeof(hid_device));
if (dev == NULL) {
return NULL;
}
dev->device_handle = INVALID_HANDLE_VALUE;
dev->blocking = TRUE;
dev->output_report_length = 0;
dev->write_buf = NULL;
dev->input_report_length = 0;
dev->feature_report_length = 0;
dev->feature_buf = NULL;
dev->last_error_str = NULL;
dev->read_pending = FALSE;
dev->read_buf = NULL;
memset(&dev->ol, 0, sizeof(dev->ol));
dev->ol.hEvent = CreateEvent(NULL, FALSE, FALSE /*initial state f=nonsignaled*/, NULL);
memset(&dev->write_ol, 0, sizeof(dev->write_ol));
dev->write_ol.hEvent = CreateEvent(NULL, FALSE, FALSE /*inital state f=nonsignaled*/, NULL);
dev->device_info = NULL;
return dev;
}
static void free_hid_device(hid_device *dev)
{
CloseHandle(dev->ol.hEvent);
CloseHandle(dev->write_ol.hEvent);
CloseHandle(dev->device_handle);
free(dev->last_error_str);
dev->last_error_str = NULL;
free(dev->write_buf);
free(dev->feature_buf);
free(dev->read_buf);
hid_free_enumeration(dev->device_info);
free(dev);
}
static void register_winapi_error_to_buffer(wchar_t **error_buffer, const WCHAR *op)
{
free(*error_buffer);
*error_buffer = NULL;
/* Only clear out error messages if NULL is passed into op */
if (!op) {
return;
}
WCHAR system_err_buf[1024];
DWORD error_code = GetLastError();
DWORD system_err_len = FormatMessageW(
FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
NULL,
error_code,
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
system_err_buf, ARRAYSIZE(system_err_buf),
NULL);
DWORD op_len = (DWORD)wcslen(op);
DWORD op_prefix_len =
op_len
+ 15 /*: (0x00000000) */
;
DWORD msg_len =
+ op_prefix_len
+ system_err_len
;
*error_buffer = (WCHAR *)calloc(msg_len + 1, sizeof (WCHAR));
WCHAR *msg = *error_buffer;
if (!msg)
return;
int printf_written = swprintf(msg, msg_len + 1, L"%.*ls: (0x%08X) %.*ls", (int)op_len, op, error_code, (int)system_err_len, system_err_buf);
if (printf_written < 0)
{
/* Highly unlikely */
msg[0] = L'\0';
return;
}
/* Get rid of the CR and LF that FormatMessage() sticks at the
end of the message. Thanks Microsoft! */
while(msg[msg_len-1] == L'\r' || msg[msg_len-1] == L'\n' || msg[msg_len-1] == L' ')
{
msg[msg_len-1] = L'\0';
msg_len--;
}
}
#if defined(__GNUC__)
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Warray-bounds"
#endif
/* A bug in GCC/mingw gives:
* error: array subscript 0 is outside array bounds of 'wchar_t *[0]' {aka 'short unsigned int *[]'} [-Werror=array-bounds]
* | free(*error_buffer);
* Which doesn't make sense in this context. */
static void register_string_error_to_buffer(wchar_t **error_buffer, const WCHAR *string_error)
{
free(*error_buffer);
*error_buffer = NULL;
if (string_error) {
*error_buffer = _wcsdup(string_error);
}
}
#if defined(__GNUC__)
# pragma GCC diagnostic pop
#endif
static void register_winapi_error(hid_device *dev, const WCHAR *op)
{
register_winapi_error_to_buffer(&dev->last_error_str, op);
}
static void register_string_error(hid_device *dev, const WCHAR *string_error)
{
register_string_error_to_buffer(&dev->last_error_str, string_error);
}
static wchar_t *last_global_error_str = NULL;
static void register_global_winapi_error(const WCHAR *op)
{
register_winapi_error_to_buffer(&last_global_error_str, op);
}
static void register_global_error(const WCHAR *string_error)
{
register_string_error_to_buffer(&last_global_error_str, string_error);
}
static HANDLE open_device(const wchar_t *path, BOOL open_rw)
{
HANDLE handle;
DWORD desired_access = (open_rw)? (GENERIC_WRITE | GENERIC_READ): 0;
DWORD share_mode = FILE_SHARE_READ|FILE_SHARE_WRITE;
handle = CreateFileW(path,
desired_access,
share_mode,
NULL,
OPEN_EXISTING,
FILE_FLAG_OVERLAPPED,/*FILE_ATTRIBUTE_NORMAL,*/
0);
return handle;
}
HID_API_EXPORT const struct hid_api_version* HID_API_CALL hid_version(void)
{
return &api_version;
}
HID_API_EXPORT const char* HID_API_CALL hid_version_str(void)
{
return HID_API_VERSION_STR;
}
int HID_API_EXPORT hid_init(void)
{
register_global_error(NULL);
#ifndef HIDAPI_USE_DDK
if (!hidapi_initialized) {
if (lookup_functions() < 0) {
register_global_winapi_error(L"resolve DLL functions");
return -1;
}
hidapi_initialized = TRUE;
}
#endif
return 0;
}
int HID_API_EXPORT hid_exit(void)
{
#ifndef HIDAPI_USE_DDK
free_library_handles();
hidapi_initialized = FALSE;
#endif
register_global_error(NULL);
return 0;
}
static void* hid_internal_get_devnode_property(DEVINST dev_node, const DEVPROPKEY* property_key, DEVPROPTYPE expected_property_type)
{
ULONG len = 0;
CONFIGRET cr;
DEVPROPTYPE property_type;
PBYTE property_value = NULL;
cr = CM_Get_DevNode_PropertyW(dev_node, property_key, &property_type, NULL, &len, 0);
if (cr != CR_BUFFER_SMALL || property_type != expected_property_type)
return NULL;
property_value = (PBYTE)calloc(len, sizeof(BYTE));
cr = CM_Get_DevNode_PropertyW(dev_node, property_key, &property_type, property_value, &len, 0);
if (cr != CR_SUCCESS) {
free(property_value);
return NULL;
}
return property_value;
}
static void* hid_internal_get_device_interface_property(const wchar_t* interface_path, const DEVPROPKEY* property_key, DEVPROPTYPE expected_property_type)
{
ULONG len = 0;
CONFIGRET cr;
DEVPROPTYPE property_type;
PBYTE property_value = NULL;
cr = CM_Get_Device_Interface_PropertyW(interface_path, property_key, &property_type, NULL, &len, 0);
if (cr != CR_BUFFER_SMALL || property_type != expected_property_type)
return NULL;
property_value = (PBYTE)calloc(len, sizeof(BYTE));
cr = CM_Get_Device_Interface_PropertyW(interface_path, property_key, &property_type, property_value, &len, 0);
if (cr != CR_SUCCESS) {
free(property_value);
return NULL;
}
return property_value;
}
static void hid_internal_towupper(wchar_t* string)
{
for (wchar_t* p = string; *p; ++p) *p = towupper(*p);
}
static int hid_internal_extract_int_token_value(wchar_t* string, const wchar_t* token)
{
int token_value;
wchar_t* startptr, * endptr;
startptr = wcsstr(string, token);
if (!startptr)
return -1;
startptr += wcslen(token);
token_value = wcstol(startptr, &endptr, 16);
if (endptr == startptr)
return -1;
return token_value;
}
static void hid_internal_get_usb_info(struct hid_device_info* dev, DEVINST dev_node)
{
wchar_t *device_id = NULL, *hardware_ids = NULL;
device_id = hid_internal_get_devnode_property(dev_node, &DEVPKEY_Device_InstanceId, DEVPROP_TYPE_STRING);
if (!device_id)
goto end;
/* Normalize to upper case */
hid_internal_towupper(device_id);
/* Check for Xbox Common Controller class (XUSB) device.
https://docs.microsoft.com/windows/win32/xinput/directinput-and-xusb-devices
https://docs.microsoft.com/windows/win32/xinput/xinput-and-directinput
*/
if (hid_internal_extract_int_token_value(device_id, L"IG_") != -1) {
/* Get devnode parent to reach out USB device. */
if (CM_Get_Parent(&dev_node, dev_node, 0) != CR_SUCCESS)
goto end;
}
/* Get the hardware ids from devnode */
hardware_ids = hid_internal_get_devnode_property(dev_node, &DEVPKEY_Device_HardwareIds, DEVPROP_TYPE_STRING_LIST);
if (!hardware_ids)
goto end;
/* Get additional information from USB device's Hardware ID
https://docs.microsoft.com/windows-hardware/drivers/install/standard-usb-identifiers
https://docs.microsoft.com/windows-hardware/drivers/usbcon/enumeration-of-interfaces-not-grouped-in-collections
*/
for (wchar_t* hardware_id = hardware_ids; *hardware_id; hardware_id += wcslen(hardware_id) + 1) {
/* Normalize to upper case */
hid_internal_towupper(hardware_id);
if (dev->release_number == 0) {
/* USB_DEVICE_DESCRIPTOR.bcdDevice value. */
int release_number = hid_internal_extract_int_token_value(hardware_id, L"REV_");
if (release_number != -1) {
dev->release_number = (unsigned short)release_number;
}
}
if (dev->interface_number == -1) {
/* USB_INTERFACE_DESCRIPTOR.bInterfaceNumber value. */
int interface_number = hid_internal_extract_int_token_value(hardware_id, L"MI_");
if (interface_number != -1) {
dev->interface_number = interface_number;
}
}
}
/* Try to get USB device manufacturer string if not provided by HidD_GetManufacturerString. */
if (wcslen(dev->manufacturer_string) == 0) {
wchar_t* manufacturer_string = hid_internal_get_devnode_property(dev_node, &DEVPKEY_Device_Manufacturer, DEVPROP_TYPE_STRING);
if (manufacturer_string) {
free(dev->manufacturer_string);
dev->manufacturer_string = manufacturer_string;
}
}
/* Try to get USB device serial number if not provided by HidD_GetSerialNumberString. */
if (wcslen(dev->serial_number) == 0) {
DEVINST usb_dev_node = dev_node;
if (dev->interface_number != -1) {
/* Get devnode parent to reach out composite parent USB device.
https://docs.microsoft.com/windows-hardware/drivers/usbcon/enumeration-of-the-composite-parent-device
*/
if (CM_Get_Parent(&usb_dev_node, dev_node, 0) != CR_SUCCESS)
goto end;
}
/* Get the device id of the USB device. */
free(device_id);
device_id = hid_internal_get_devnode_property(usb_dev_node, &DEVPKEY_Device_InstanceId, DEVPROP_TYPE_STRING);
if (!device_id)
goto end;
/* Extract substring after last '\\' of Instance ID.
For USB devices it may contain device's serial number.
https://docs.microsoft.com/windows-hardware/drivers/install/instance-ids
*/
for (wchar_t *ptr = device_id + wcslen(device_id); ptr > device_id; --ptr) {
/* Instance ID is unique only within the scope of the bus.
For USB devices it means that serial number is not available. Skip. */
if (*ptr == L'&')
break;
if (*ptr == L'\\') {
free(dev->serial_number);
dev->serial_number = _wcsdup(ptr + 1);
break;
}
}
}
/* If we can't get the interface number, it means that there is only one interface. */
if (dev->interface_number == -1)
dev->interface_number = 0;
end:
free(device_id);
free(hardware_ids);
}
/* HidD_GetProductString/HidD_GetManufacturerString/HidD_GetSerialNumberString is not working for BLE HID devices
Request this info via dev node properties instead.
https://docs.microsoft.com/answers/questions/401236/hidd-getproductstring-with-ble-hid-device.html
*/
static void hid_internal_get_ble_info(struct hid_device_info* dev, DEVINST dev_node)
{
if (wcslen(dev->manufacturer_string) == 0) {
/* Manufacturer Name String (UUID: 0x2A29) */
wchar_t* manufacturer_string = hid_internal_get_devnode_property(dev_node, (const DEVPROPKEY*)&PKEY_DeviceInterface_Bluetooth_Manufacturer, DEVPROP_TYPE_STRING);
if (manufacturer_string) {
free(dev->manufacturer_string);
dev->manufacturer_string = manufacturer_string;
}
}
if (wcslen(dev->serial_number) == 0) {
/* Serial Number String (UUID: 0x2A25) */
wchar_t* serial_number = hid_internal_get_devnode_property(dev_node, (const DEVPROPKEY*)&PKEY_DeviceInterface_Bluetooth_DeviceAddress, DEVPROP_TYPE_STRING);
if (serial_number) {
free(dev->serial_number);
dev->serial_number = serial_number;
}
}
if (wcslen(dev->product_string) == 0) {
/* Model Number String (UUID: 0x2A24) */
wchar_t* product_string = hid_internal_get_devnode_property(dev_node, (const DEVPROPKEY*)&PKEY_DeviceInterface_Bluetooth_ModelNumber, DEVPROP_TYPE_STRING);
if (!product_string) {
DEVINST parent_dev_node = 0;
/* Fallback: Get devnode grandparent to reach out Bluetooth LE device node */
if (CM_Get_Parent(&parent_dev_node, dev_node, 0) == CR_SUCCESS) {
/* Device Name (UUID: 0x2A00) */
product_string = hid_internal_get_devnode_property(parent_dev_node, &DEVPKEY_NAME, DEVPROP_TYPE_STRING);
}
}
if (product_string) {
free(dev->product_string);
dev->product_string = product_string;
}
}
}
static void hid_internal_get_info(const wchar_t* interface_path, struct hid_device_info* dev)
{
wchar_t *device_id = NULL, *compatible_ids = NULL;
CONFIGRET cr;
DEVINST dev_node;
/* Get the device id from interface path */
device_id = hid_internal_get_device_interface_property(interface_path, &DEVPKEY_Device_InstanceId, DEVPROP_TYPE_STRING);
if (!device_id)
goto end;
/* Open devnode from device id */
cr = CM_Locate_DevNodeW(&dev_node, (DEVINSTID_W)device_id, CM_LOCATE_DEVNODE_NORMAL);
if (cr != CR_SUCCESS)
goto end;
/* Get devnode parent */
cr = CM_Get_Parent(&dev_node, dev_node, 0);
if (cr != CR_SUCCESS)
goto end;
/* Get the compatible ids from parent devnode */
compatible_ids = hid_internal_get_devnode_property(dev_node, &DEVPKEY_Device_CompatibleIds, DEVPROP_TYPE_STRING_LIST);
if (!compatible_ids)
goto end;
/* Now we can parse parent's compatible IDs to find out the device bus type */
for (wchar_t* compatible_id = compatible_ids; *compatible_id; compatible_id += wcslen(compatible_id) + 1) {
/* Normalize to upper case */
hid_internal_towupper(compatible_id);
/* USB devices
https://docs.microsoft.com/windows-hardware/drivers/hid/plug-and-play-support
https://docs.microsoft.com/windows-hardware/drivers/install/standard-usb-identifiers */
if (wcsstr(compatible_id, L"USB") != NULL) {
dev->bus_type = HID_API_BUS_USB;
hid_internal_get_usb_info(dev, dev_node);
break;
}
/* Bluetooth devices
https://docs.microsoft.com/windows-hardware/drivers/bluetooth/installing-a-bluetooth-device */
if (wcsstr(compatible_id, L"BTHENUM") != NULL) {
dev->bus_type = HID_API_BUS_BLUETOOTH;
break;
}
/* Bluetooth LE devices */
if (wcsstr(compatible_id, L"BTHLEDEVICE") != NULL) {
dev->bus_type = HID_API_BUS_BLUETOOTH;
hid_internal_get_ble_info(dev, dev_node);
break;
}
/* I2C devices
https://docs.microsoft.com/windows-hardware/drivers/hid/plug-and-play-support-and-power-management */
if (wcsstr(compatible_id, L"PNP0C50") != NULL) {
dev->bus_type = HID_API_BUS_I2C;
break;
}
/* SPI devices
https://docs.microsoft.com/windows-hardware/drivers/hid/plug-and-play-for-spi */
if (wcsstr(compatible_id, L"PNP0C51") != NULL) {
dev->bus_type = HID_API_BUS_SPI;
break;
}
}
end:
free(device_id);
free(compatible_ids);
}
static char *hid_internal_UTF16toUTF8(const wchar_t *src)
{
char *dst = NULL;
int len = WideCharToMultiByte(CP_UTF8, WC_ERR_INVALID_CHARS, src, -1, NULL, 0, NULL, NULL);
if (len) {
dst = (char*)calloc(len, sizeof(char));
if (dst == NULL) {
return NULL;
}
WideCharToMultiByte(CP_UTF8, WC_ERR_INVALID_CHARS, src, -1, dst, len, NULL, NULL);
}
return dst;
}
static wchar_t *hid_internal_UTF8toUTF16(const char *src)
{
wchar_t *dst = NULL;
int len = MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, src, -1, NULL, 0);
if (len) {
dst = (wchar_t*)calloc(len, sizeof(wchar_t));
if (dst == NULL) {
return NULL;
}
MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, src, -1, dst, len);
}
return dst;
}
static struct hid_device_info *hid_internal_get_device_info(const wchar_t *path, HANDLE handle)
{
struct hid_device_info *dev = NULL; /* return object */
HIDD_ATTRIBUTES attrib;
PHIDP_PREPARSED_DATA pp_data = NULL;
HIDP_CAPS caps;
wchar_t string[MAX_STRING_WCHARS];
/* Create the record. */
dev = (struct hid_device_info*)calloc(1, sizeof(struct hid_device_info));
if (dev == NULL) {
return NULL;
}
/* Fill out the record */
dev->next = NULL;
dev->path = hid_internal_UTF16toUTF8(path);
dev->interface_number = -1;
attrib.Size = sizeof(HIDD_ATTRIBUTES);
if (HidD_GetAttributes(handle, &attrib)) {
/* VID/PID */
dev->vendor_id = attrib.VendorID;
dev->product_id = attrib.ProductID;
/* Release Number */
dev->release_number = attrib.VersionNumber;
}
/* Get the Usage Page and Usage for this device. */
if (HidD_GetPreparsedData(handle, &pp_data)) {
if (HidP_GetCaps(pp_data, &caps) == HIDP_STATUS_SUCCESS) {
dev->usage_page = caps.UsagePage;
dev->usage = caps.Usage;
}
HidD_FreePreparsedData(pp_data);
}
/* Serial Number */
string[0] = L'\0';
HidD_GetSerialNumberString(handle, string, sizeof(string));
string[MAX_STRING_WCHARS - 1] = L'\0';
dev->serial_number = _wcsdup(string);
/* Manufacturer String */
string[0] = L'\0';
HidD_GetManufacturerString(handle, string, sizeof(string));
string[MAX_STRING_WCHARS - 1] = L'\0';
dev->manufacturer_string = _wcsdup(string);
/* Product String */
string[0] = L'\0';
HidD_GetProductString(handle, string, sizeof(string));
string[MAX_STRING_WCHARS - 1] = L'\0';
dev->product_string = _wcsdup(string);
hid_internal_get_info(path, dev);
return dev;
}
struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id)
{
struct hid_device_info *root = NULL; /* return object */
struct hid_device_info *cur_dev = NULL;
GUID interface_class_guid;
CONFIGRET cr;
wchar_t* device_interface_list = NULL;
DWORD len;
if (hid_init() < 0) {
/* register_global_error: global error is reset by hid_init */
return NULL;
}
/* Retrieve HID Interface Class GUID
https://docs.microsoft.com/windows-hardware/drivers/install/guid-devinterface-hid */
HidD_GetHidGuid(&interface_class_guid);
/* Get the list of all device interfaces belonging to the HID class. */
/* Retry in case of list was changed between calls to
CM_Get_Device_Interface_List_SizeW and CM_Get_Device_Interface_ListW */
do {
cr = CM_Get_Device_Interface_List_SizeW(&len, &interface_class_guid, NULL, CM_GET_DEVICE_INTERFACE_LIST_PRESENT);
if (cr != CR_SUCCESS) {
register_global_error(L"Failed to get size of HID device interface list");
break;
}
if (device_interface_list != NULL) {
free(device_interface_list);
}
device_interface_list = (wchar_t*)calloc(len, sizeof(wchar_t));
if (device_interface_list == NULL) {
register_global_error(L"Failed to allocate memory for HID device interface list");
return NULL;
}
cr = CM_Get_Device_Interface_ListW(&interface_class_guid, NULL, device_interface_list, len, CM_GET_DEVICE_INTERFACE_LIST_PRESENT);
if (cr != CR_SUCCESS && cr != CR_BUFFER_SMALL) {
register_global_error(L"Failed to get HID device interface list");
}
} while (cr == CR_BUFFER_SMALL);
if (cr != CR_SUCCESS) {
goto end_of_function;
}
/* Iterate over each device interface in the HID class, looking for the right one. */
for (wchar_t* device_interface = device_interface_list; *device_interface; device_interface += wcslen(device_interface) + 1) {
HANDLE device_handle = INVALID_HANDLE_VALUE;
HIDD_ATTRIBUTES attrib;
/* Open read-only handle to the device */
device_handle = open_device(device_interface, FALSE);
/* Check validity of device_handle. */
if (device_handle == INVALID_HANDLE_VALUE) {
/* Unable to open the device. */
continue;
}
/* Get the Vendor ID and Product ID for this device. */
attrib.Size = sizeof(HIDD_ATTRIBUTES);
if (!HidD_GetAttributes(device_handle, &attrib)) {
goto cont_close;
}
/* Check the VID/PID to see if we should add this
device to the enumeration list. */
if ((vendor_id == 0x0 || attrib.VendorID == vendor_id) &&
(product_id == 0x0 || attrib.ProductID == product_id)) {
/* VID/PID match. Create the record. */
struct hid_device_info *tmp = hid_internal_get_device_info(device_interface, device_handle);
if (tmp == NULL) {
goto cont_close;
}
if (cur_dev) {
cur_dev->next = tmp;
}
else {
root = tmp;
}
cur_dev = tmp;
}
cont_close:
CloseHandle(device_handle);
}
if (root == NULL) {
if (vendor_id == 0 && product_id == 0) {
register_global_error(L"No HID devices found in the system.");
} else {
register_global_error(L"No HID devices with requested VID/PID found in the system.");
}
}
end_of_function:
free(device_interface_list);
return root;
}
void HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs)
{
/* TODO: Merge this with the Linux version. This function is platform-independent. */
struct hid_device_info *d = devs;
while (d) {
struct hid_device_info *next = d->next;
free(d->path);
free(d->serial_number);
free(d->manufacturer_string);
free(d->product_string);
free(d);
d = next;
}
}
HID_API_EXPORT hid_device * HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number)
{
/* TODO: Merge this functions with the Linux version. This function should be platform independent. */
struct hid_device_info *devs, *cur_dev;
const char *path_to_open = NULL;
hid_device *handle = NULL;
/* register_global_error: global error is reset by hid_enumerate/hid_init */
devs = hid_enumerate(vendor_id, product_id);
if (!devs) {
/* register_global_error: global error is already set by hid_enumerate */
return NULL;
}
cur_dev = devs;
while (cur_dev) {
if (cur_dev->vendor_id == vendor_id &&
cur_dev->product_id == product_id) {
if (serial_number) {
if (cur_dev->serial_number && wcscmp(serial_number, cur_dev->serial_number) == 0) {
path_to_open = cur_dev->path;
break;
}
}
else {
path_to_open = cur_dev->path;
break;
}
}
cur_dev = cur_dev->next;
}
if (path_to_open) {
/* Open the device */
handle = hid_open_path(path_to_open);
} else {
register_global_error(L"Device with requested VID/PID/(SerialNumber) not found");
}
hid_free_enumeration(devs);
return handle;
}
HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path)
{
hid_device *dev = NULL;
wchar_t* interface_path = NULL;
HANDLE device_handle = INVALID_HANDLE_VALUE;
PHIDP_PREPARSED_DATA pp_data = NULL;
HIDP_CAPS caps;
if (hid_init() < 0) {
/* register_global_error: global error is reset by hid_init */
goto end_of_function;
}
interface_path = hid_internal_UTF8toUTF16(path);
if (!interface_path) {
register_global_error(L"Path conversion failure");
goto end_of_function;
}
/* Open a handle to the device */
device_handle = open_device(interface_path, TRUE);
/* Check validity of write_handle. */
if (device_handle == INVALID_HANDLE_VALUE) {
/* System devices, such as keyboards and mice, cannot be opened in
read-write mode, because the system takes exclusive control over
them. This is to prevent keyloggers. However, feature reports
can still be sent and received. Retry opening the device, but
without read/write access. */
device_handle = open_device(interface_path, FALSE);
/* Check the validity of the limited device_handle. */
if (device_handle == INVALID_HANDLE_VALUE) {
register_global_winapi_error(L"open_device");
goto end_of_function;
}
}
/* Set the Input Report buffer size to 64 reports. */
if (!HidD_SetNumInputBuffers(device_handle, 64)) {
register_global_winapi_error(L"set input buffers");
goto end_of_function;
}
/* Get the Input Report length for the device. */
if (!HidD_GetPreparsedData(device_handle, &pp_data)) {
register_global_winapi_error(L"get preparsed data");
goto end_of_function;
}
if (HidP_GetCaps(pp_data, &caps) != HIDP_STATUS_SUCCESS) {
register_global_error(L"HidP_GetCaps");
goto end_of_function;
}
dev = new_hid_device();
if (dev == NULL) {
register_global_error(L"hid_device allocation error");
goto end_of_function;
}
dev->device_handle = device_handle;
device_handle = INVALID_HANDLE_VALUE;
dev->output_report_length = caps.OutputReportByteLength;
dev->input_report_length = caps.InputReportByteLength;
dev->feature_report_length = caps.FeatureReportByteLength;
dev->read_buf = (char*) malloc(dev->input_report_length);
dev->device_info = hid_internal_get_device_info(interface_path, dev->device_handle);
end_of_function:
free(interface_path);
CloseHandle(device_handle);
if (pp_data) {
HidD_FreePreparsedData(pp_data);