/
SDL_hidapijoystick.c
1124 lines (961 loc) · 35.5 KB
1
2
/*
Simple DirectMedia Layer
3
Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
#include "../../SDL_internal.h"
#ifdef SDL_JOYSTICK_HIDAPI
25
#include "SDL_assert.h"
26
#include "SDL_atomic.h"
27
28
29
#include "SDL_endian.h"
#include "SDL_hints.h"
#include "SDL_log.h"
30
#include "SDL_thread.h"
31
32
33
34
#include "SDL_timer.h"
#include "SDL_joystick.h"
#include "../SDL_sysjoystick.h"
#include "SDL_hidapijoystick_c.h"
35
#include "SDL_hidapi_rumble.h"
36
#include "../../SDL_hints_c.h"
37
38
39
#if defined(__WIN32__)
#include "../../core/windows/SDL_windows.h"
40
#include "../windows/SDL_rawinputjoystick_c.h"
41
42
43
44
45
46
#endif
#if defined(__MACOSX__)
#include <CoreFoundation/CoreFoundation.h>
#include <mach/mach.h>
#include <IOKit/IOKitLib.h>
47
#include <IOKit/hid/IOHIDDevice.h>
48
49
50
51
52
53
54
55
56
#include <IOKit/usb/USBSpec.h>
#endif
#if defined(__LINUX__)
#include "../../core/linux/SDL_udev.h"
#ifdef SDL_USE_LIBUDEV
#include <poll.h>
#endif
#endif
57
58
struct joystick_hwdata
59
{
60
SDL_HIDAPI_Device *device;
61
62
};
63
64
65
66
67
68
69
70
71
72
73
74
static SDL_HIDAPI_DeviceDriver *SDL_HIDAPI_drivers[] = {
#ifdef SDL_JOYSTICK_HIDAPI_PS4
&SDL_HIDAPI_DriverPS4,
#endif
#ifdef SDL_JOYSTICK_HIDAPI_STEAM
&SDL_HIDAPI_DriverSteam,
#endif
#ifdef SDL_JOYSTICK_HIDAPI_SWITCH
&SDL_HIDAPI_DriverSwitch,
#endif
#ifdef SDL_JOYSTICK_HIDAPI_XBOX360
&SDL_HIDAPI_DriverXbox360,
75
&SDL_HIDAPI_DriverXbox360W,
76
77
78
79
#endif
#ifdef SDL_JOYSTICK_HIDAPI_XBOXONE
&SDL_HIDAPI_DriverXboxOne,
#endif
80
81
82
#ifdef SDL_JOYSTICK_HIDAPI_GAMECUBE
&SDL_HIDAPI_DriverGameCube,
#endif
83
};
84
static int SDL_HIDAPI_numdrivers = 0;
85
static SDL_SpinLock SDL_HIDAPI_spinlock;
86
87
static SDL_HIDAPI_Device *SDL_HIDAPI_devices;
static int SDL_HIDAPI_numjoysticks = 0;
88
static SDL_bool initialized = SDL_FALSE;
89
static SDL_bool shutting_down = SDL_FALSE;
90
91
92
93
94
#if defined(SDL_USE_LIBUDEV)
static const SDL_UDEV_Symbols * usyms = NULL;
#endif
95
96
97
98
99
100
101
static struct
{
SDL_bool m_bHaveDevicesChanged;
SDL_bool m_bCanGetNotifications;
Uint32 m_unLastDetect;
#if defined(__WIN32__)
102
SDL_threadID m_nThreadID;
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
WNDCLASSEXA m_wndClass;
HWND m_hwndMsg;
HDEVNOTIFY m_hNotify;
double m_flLastWin32MessageCheck;
#endif
#if defined(__MACOSX__)
IONotificationPortRef m_notificationPort;
mach_port_t m_notificationMach;
#endif
#if defined(SDL_USE_LIBUDEV)
struct udev *m_pUdev;
struct udev_monitor *m_pUdevMonitor;
int m_nUdevFd;
#endif
} SDL_HIDAPI_discovery;
#ifdef __WIN32__
struct _DEV_BROADCAST_HDR
{
DWORD dbch_size;
DWORD dbch_devicetype;
DWORD dbch_reserved;
};
typedef struct _DEV_BROADCAST_DEVICEINTERFACE_A
{
DWORD dbcc_size;
DWORD dbcc_devicetype;
DWORD dbcc_reserved;
GUID dbcc_classguid;
char dbcc_name[ 1 ];
} DEV_BROADCAST_DEVICEINTERFACE_A, *PDEV_BROADCAST_DEVICEINTERFACE_A;
typedef struct _DEV_BROADCAST_HDR DEV_BROADCAST_HDR;
#define DBT_DEVICEARRIVAL 0x8000 /* system detected a new device */
141
#define DBT_DEVICEREMOVECOMPLETE 0x8004 /* device was removed from the system */
142
143
144
145
#define DBT_DEVTYP_DEVICEINTERFACE 0x00000005 /* device interface class */
#define DBT_DEVNODES_CHANGED 0x0007
#define DBT_CONFIGCHANGED 0x0018
#define DBT_DEVICETYPESPECIFIC 0x8005 /* type specific event */
146
#define DBT_DEVINSTSTARTED 0x8008 /* device installed and started */
147
148
149
150
151
152
153
154
155
156
#include <initguid.h>
DEFINE_GUID(GUID_DEVINTERFACE_USB_DEVICE, 0xA5DCBF10L, 0x6530, 0x11D2, 0x90, 0x1F, 0x00, 0xC0, 0x4F, 0xB9, 0x51, 0xED);
static LRESULT CALLBACK ControllerWndProc(HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
{
switch (message) {
case WM_DEVICECHANGE:
switch (wParam) {
case DBT_DEVICEARRIVAL:
157
case DBT_DEVICEREMOVECOMPLETE:
158
if (((DEV_BROADCAST_HDR*)lParam)->dbch_devicetype == DBT_DEVTYP_DEVICEINTERFACE) {
159
SDL_HIDAPI_discovery.m_bHaveDevicesChanged = SDL_TRUE;
160
161
162
}
break;
}
163
return TRUE;
164
165
166
167
168
169
170
171
}
return DefWindowProc(hwnd, message, wParam, lParam);
}
#endif /* __WIN32__ */
#if defined(__MACOSX__)
172
static void CallbackIOServiceFunc(void *context, io_iterator_t portIterator)
173
174
{
/* Must drain the iterator, or we won't receive new notifications */
175
176
io_object_t entry;
while ((entry = IOIteratorNext(portIterator)) != 0) {
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
IOObjectRelease(entry);
*(SDL_bool*)context = SDL_TRUE;
}
}
#endif /* __MACOSX__ */
static void
HIDAPI_InitializeDiscovery()
{
SDL_HIDAPI_discovery.m_bHaveDevicesChanged = SDL_TRUE;
SDL_HIDAPI_discovery.m_bCanGetNotifications = SDL_FALSE;
SDL_HIDAPI_discovery.m_unLastDetect = 0;
#if defined(__WIN32__)
SDL_HIDAPI_discovery.m_nThreadID = SDL_ThreadID();
SDL_memset(&SDL_HIDAPI_discovery.m_wndClass, 0x0, sizeof(SDL_HIDAPI_discovery.m_wndClass));
SDL_HIDAPI_discovery.m_wndClass.hInstance = GetModuleHandle(NULL);
195
SDL_HIDAPI_discovery.m_wndClass.lpszClassName = "SDL_HIDAPI_DEVICE_DETECTION";
196
197
198
199
SDL_HIDAPI_discovery.m_wndClass.lpfnWndProc = ControllerWndProc; /* This function is called by windows */
SDL_HIDAPI_discovery.m_wndClass.cbSize = sizeof(WNDCLASSEX);
RegisterClassExA(&SDL_HIDAPI_discovery.m_wndClass);
200
SDL_HIDAPI_discovery.m_hwndMsg = CreateWindowExA(0, "SDL_HIDAPI_DEVICE_DETECTION", NULL, 0, 0, 0, 0, 0, HWND_MESSAGE, NULL, NULL, NULL);
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
{
DEV_BROADCAST_DEVICEINTERFACE_A devBroadcast;
SDL_memset( &devBroadcast, 0x0, sizeof( devBroadcast ) );
devBroadcast.dbcc_size = sizeof( devBroadcast );
devBroadcast.dbcc_devicetype = DBT_DEVTYP_DEVICEINTERFACE;
devBroadcast.dbcc_classguid = GUID_DEVINTERFACE_USB_DEVICE;
/* DEVICE_NOTIFY_ALL_INTERFACE_CLASSES is important, makes GUID_DEVINTERFACE_USB_DEVICE ignored,
* but that seems to be necessary to get a notice after each individual usb input device actually
* installs, rather than just as the composite device is seen.
*/
SDL_HIDAPI_discovery.m_hNotify = RegisterDeviceNotification( SDL_HIDAPI_discovery.m_hwndMsg, &devBroadcast, DEVICE_NOTIFY_WINDOW_HANDLE | DEVICE_NOTIFY_ALL_INTERFACE_CLASSES );
SDL_HIDAPI_discovery.m_bCanGetNotifications = ( SDL_HIDAPI_discovery.m_hNotify != 0 );
}
217
218
219
220
221
222
223
#endif /* __WIN32__ */
#if defined(__MACOSX__)
SDL_HIDAPI_discovery.m_notificationPort = IONotificationPortCreate(kIOMasterPortDefault);
if (SDL_HIDAPI_discovery.m_notificationPort) {
{
io_iterator_t portIterator = 0;
224
io_object_t entry;
225
226
227
228
229
230
231
IOReturn result = IOServiceAddMatchingNotification(
SDL_HIDAPI_discovery.m_notificationPort,
kIOFirstMatchNotification,
IOServiceMatching(kIOHIDDeviceKey),
CallbackIOServiceFunc, &SDL_HIDAPI_discovery.m_bHaveDevicesChanged, &portIterator);
if (result == 0) {
232
/* Must drain the existing iterator, or we won't receive new notifications */
233
while ((entry = IOIteratorNext(portIterator)) != 0) {
234
235
236
237
238
239
240
241
242
IOObjectRelease(entry);
}
} else {
IONotificationPortDestroy(SDL_HIDAPI_discovery.m_notificationPort);
SDL_HIDAPI_discovery.m_notificationPort = nil;
}
}
{
io_iterator_t portIterator = 0;
243
io_object_t entry;
244
245
246
247
248
249
250
IOReturn result = IOServiceAddMatchingNotification(
SDL_HIDAPI_discovery.m_notificationPort,
kIOTerminatedNotification,
IOServiceMatching(kIOHIDDeviceKey),
CallbackIOServiceFunc, &SDL_HIDAPI_discovery.m_bHaveDevicesChanged, &portIterator);
if (result == 0) {
251
/* Must drain the existing iterator, or we won't receive new notifications */
252
while ((entry = IOIteratorNext(portIterator)) != 0) {
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
IOObjectRelease(entry);
}
} else {
IONotificationPortDestroy(SDL_HIDAPI_discovery.m_notificationPort);
SDL_HIDAPI_discovery.m_notificationPort = nil;
}
}
}
SDL_HIDAPI_discovery.m_notificationMach = MACH_PORT_NULL;
if (SDL_HIDAPI_discovery.m_notificationPort) {
SDL_HIDAPI_discovery.m_notificationMach = IONotificationPortGetMachPort(SDL_HIDAPI_discovery.m_notificationPort);
}
SDL_HIDAPI_discovery.m_bCanGetNotifications = (SDL_HIDAPI_discovery.m_notificationMach != MACH_PORT_NULL);
#endif // __MACOSX__
#if defined(SDL_USE_LIBUDEV)
SDL_HIDAPI_discovery.m_pUdev = NULL;
SDL_HIDAPI_discovery.m_pUdevMonitor = NULL;
SDL_HIDAPI_discovery.m_nUdevFd = -1;
276
277
278
279
usyms = SDL_UDEV_GetUdevSyms();
if (usyms) {
SDL_HIDAPI_discovery.m_pUdev = usyms->udev_new();
}
280
if (SDL_HIDAPI_discovery.m_pUdev) {
281
SDL_HIDAPI_discovery.m_pUdevMonitor = usyms->udev_monitor_new_from_netlink(SDL_HIDAPI_discovery.m_pUdev, "udev");
282
if (SDL_HIDAPI_discovery.m_pUdevMonitor) {
283
284
usyms->udev_monitor_enable_receiving(SDL_HIDAPI_discovery.m_pUdevMonitor);
SDL_HIDAPI_discovery.m_nUdevFd = usyms->udev_monitor_get_fd(SDL_HIDAPI_discovery.m_pUdevMonitor);
285
SDL_HIDAPI_discovery.m_bCanGetNotifications = SDL_TRUE;
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
}
}
#endif /* SDL_USE_LIBUDEV */
}
static void
HIDAPI_UpdateDiscovery()
{
if (!SDL_HIDAPI_discovery.m_bCanGetNotifications) {
const Uint32 SDL_HIDAPI_DETECT_INTERVAL_MS = 3000; /* Update every 3 seconds */
Uint32 now = SDL_GetTicks();
if (!SDL_HIDAPI_discovery.m_unLastDetect || SDL_TICKS_PASSED(now, SDL_HIDAPI_discovery.m_unLastDetect + SDL_HIDAPI_DETECT_INTERVAL_MS)) {
SDL_HIDAPI_discovery.m_bHaveDevicesChanged = SDL_TRUE;
SDL_HIDAPI_discovery.m_unLastDetect = now;
}
return;
}
305
306
#if defined(__WIN32__)
#if 0 /* just let the usual SDL_PumpEvents loop dispatch these, fixing bug 4286. --ryan. */
307
308
309
310
311
312
313
314
315
316
317
/* We'll only get messages on the same thread that created the window */
if (SDL_ThreadID() == SDL_HIDAPI_discovery.m_nThreadID) {
MSG msg;
while (PeekMessage(&msg, SDL_HIDAPI_discovery.m_hwndMsg, 0, 0, PM_NOREMOVE)) {
if (GetMessageA(&msg, SDL_HIDAPI_discovery.m_hwndMsg, 0, 0) != 0) {
TranslateMessage(&msg);
DispatchMessage(&msg);
}
}
}
#endif
318
#endif /* __WIN32__ */
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
#if defined(__MACOSX__)
if (SDL_HIDAPI_discovery.m_notificationPort) {
struct { mach_msg_header_t hdr; char payload[ 4096 ]; } msg;
while (mach_msg(&msg.hdr, MACH_RCV_MSG | MACH_RCV_TIMEOUT, 0, sizeof(msg), SDL_HIDAPI_discovery.m_notificationMach, 0, MACH_PORT_NULL) == KERN_SUCCESS) {
IODispatchCalloutFromMessage(NULL, &msg.hdr, SDL_HIDAPI_discovery.m_notificationPort);
}
}
#endif
#if defined(SDL_USE_LIBUDEV)
if (SDL_HIDAPI_discovery.m_nUdevFd >= 0) {
/* Drain all notification events.
* We don't expect a lot of device notifications so just
* do a new discovery on any kind or number of notifications.
* This could be made more restrictive if necessary.
*/
for (;;) {
struct pollfd PollUdev;
338
struct udev_device *pUdevDevice;
339
340
341
342
343
344
345
PollUdev.fd = SDL_HIDAPI_discovery.m_nUdevFd;
PollUdev.events = POLLIN;
if (poll(&PollUdev, 1, 0) != 1) {
break;
}
346
SDL_HIDAPI_discovery.m_bHaveDevicesChanged = SDL_TRUE;
347
348
pUdevDevice = usyms->udev_monitor_receive_device(SDL_HIDAPI_discovery.m_pUdevMonitor);
349
if (pUdevDevice) {
350
usyms->udev_device_unref(pUdevDevice);
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
}
}
}
#endif
}
static void
HIDAPI_ShutdownDiscovery()
{
#if defined(__WIN32__)
if (SDL_HIDAPI_discovery.m_hNotify)
UnregisterDeviceNotification(SDL_HIDAPI_discovery.m_hNotify);
if (SDL_HIDAPI_discovery.m_hwndMsg) {
DestroyWindow(SDL_HIDAPI_discovery.m_hwndMsg);
}
UnregisterClassA(SDL_HIDAPI_discovery.m_wndClass.lpszClassName, SDL_HIDAPI_discovery.m_wndClass.hInstance);
#endif
#if defined(__MACOSX__)
if (SDL_HIDAPI_discovery.m_notificationPort) {
IONotificationPortDestroy(SDL_HIDAPI_discovery.m_notificationPort);
}
#endif
#if defined(SDL_USE_LIBUDEV)
378
if (usyms) {
379
380
381
382
383
384
if (SDL_HIDAPI_discovery.m_pUdevMonitor) {
usyms->udev_monitor_unref(SDL_HIDAPI_discovery.m_pUdevMonitor);
}
if (SDL_HIDAPI_discovery.m_pUdev) {
usyms->udev_unref(SDL_HIDAPI_discovery.m_pUdev);
}
385
386
SDL_UDEV_ReleaseUdevSyms();
usyms = NULL;
387
388
389
390
}
#endif
}
391
392
393
static void HIDAPI_JoystickDetect(void);
static void HIDAPI_JoystickClose(SDL_Joystick * joystick);
394
static SDL_bool
395
HIDAPI_IsDeviceSupported(Uint16 vendor_id, Uint16 product_id, Uint16 version, const char *name)
396
397
{
int i;
398
SDL_GameControllerType type = SDL_GetJoystickGameControllerType(name, vendor_id, product_id, -1, 0, 0, 0);
399
400
401
for (i = 0; i < SDL_arraysize(SDL_HIDAPI_drivers); ++i) {
SDL_HIDAPI_DeviceDriver *driver = SDL_HIDAPI_drivers[i];
402
if (driver->enabled && driver->IsSupportedDevice(name, type, vendor_id, product_id, version, -1, 0, 0, 0)) {
403
404
405
406
407
408
return SDL_TRUE;
}
}
return SDL_FALSE;
}
409
410
411
static SDL_HIDAPI_DeviceDriver *
HIDAPI_GetDeviceDriver(SDL_HIDAPI_Device *device)
{
412
413
414
415
const Uint16 USAGE_PAGE_GENERIC_DESKTOP = 0x0001;
const Uint16 USAGE_JOYSTICK = 0x0004;
const Uint16 USAGE_GAMEPAD = 0x0005;
const Uint16 USAGE_MULTIAXISCONTROLLER = 0x0008;
416
int i;
417
SDL_GameControllerType type;
418
419
420
421
422
if (SDL_ShouldIgnoreJoystick(device->name, device->guid)) {
return NULL;
}
423
424
425
426
427
428
429
#ifdef SDL_JOYSTICK_RAWINPUT
if (RAWINPUT_IsDevicePresent(device->vendor_id, device->product_id, device->version)) {
/* The RAWINPUT driver is taking care of this device */
return NULL;
}
#endif
430
431
432
433
434
435
436
if (device->vendor_id != USB_VENDOR_VALVE) {
if (device->usage_page && device->usage_page != USAGE_PAGE_GENERIC_DESKTOP) {
return NULL;
}
if (device->usage && device->usage != USAGE_JOYSTICK && device->usage != USAGE_GAMEPAD && device->usage != USAGE_MULTIAXISCONTROLLER) {
return NULL;
}
437
438
}
439
type = SDL_GetJoystickGameControllerType(device->name, device->vendor_id, device->product_id, device->interface_number, device->interface_class, device->interface_subclass, device->interface_protocol);
440
441
for (i = 0; i < SDL_arraysize(SDL_HIDAPI_drivers); ++i) {
SDL_HIDAPI_DeviceDriver *driver = SDL_HIDAPI_drivers[i];
442
if (driver->enabled && driver->IsSupportedDevice(device->name, type, device->vendor_id, device->product_id, device->version, device->interface_number, device->interface_class, device->interface_subclass, device->interface_protocol)) {
443
444
445
446
447
448
449
return driver;
}
}
return NULL;
}
static SDL_HIDAPI_Device *
450
HIDAPI_GetDeviceByIndex(int device_index, SDL_JoystickID *pJoystickID)
451
452
453
454
{
SDL_HIDAPI_Device *device = SDL_HIDAPI_devices;
while (device) {
if (device->driver) {
455
456
457
458
459
if (device_index < device->num_joysticks) {
if (pJoystickID) {
*pJoystickID = device->joysticks[device_index];
}
return device;
460
}
461
device_index -= device->num_joysticks;
462
463
464
}
device = device->next;
}
465
return NULL;
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
}
static SDL_HIDAPI_Device *
HIDAPI_GetJoystickByInfo(const char *path, Uint16 vendor_id, Uint16 product_id)
{
SDL_HIDAPI_Device *device = SDL_HIDAPI_devices;
while (device) {
if (device->vendor_id == vendor_id && device->product_id == product_id &&
SDL_strcmp(device->path, path) == 0) {
break;
}
device = device->next;
}
return device;
}
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
static void
HIDAPI_SetupDeviceDriver(SDL_HIDAPI_Device *device)
{
if (device->driver) {
/* Already setup */
return;
}
device->driver = HIDAPI_GetDeviceDriver(device);
if (device->driver) {
const char *name = device->driver->GetDeviceName(device->vendor_id, device->product_id);
if (name) {
SDL_free(device->name);
device->name = SDL_strdup(name);
}
}
/* Initialize the device, which may cause a connected event */
if (device->driver && !device->driver->InitDevice(device)) {
device->driver = NULL;
}
}
static void
HIDAPI_CleanupDeviceDriver(SDL_HIDAPI_Device *device)
{
if (!device->driver) {
/* Already cleaned up */
return;
}
/* Disconnect any joysticks */
514
while (device->num_joysticks) {
515
HIDAPI_JoystickDisconnected(device, device->joysticks[0], SDL_FALSE);
516
517
518
519
520
521
}
device->driver->FreeDevice(device);
device->driver = NULL;
}
522
523
524
525
static void SDLCALL
SDL_HIDAPIDriverHintChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
{
int i;
526
SDL_HIDAPI_Device *device;
527
SDL_bool enabled = SDL_GetStringBoolean(hint, SDL_TRUE);
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
if (SDL_strcmp(name, SDL_HINT_JOYSTICK_HIDAPI) == 0) {
for (i = 0; i < SDL_arraysize(SDL_HIDAPI_drivers); ++i) {
SDL_HIDAPI_DeviceDriver *driver = SDL_HIDAPI_drivers[i];
driver->enabled = SDL_GetHintBoolean(driver->hint, enabled);
}
} else {
for (i = 0; i < SDL_arraysize(SDL_HIDAPI_drivers); ++i) {
SDL_HIDAPI_DeviceDriver *driver = SDL_HIDAPI_drivers[i];
if (SDL_strcmp(name, driver->hint) == 0) {
driver->enabled = enabled;
}
}
}
543
544
545
546
547
548
549
550
SDL_HIDAPI_numdrivers = 0;
for (i = 0; i < SDL_arraysize(SDL_HIDAPI_drivers); ++i) {
SDL_HIDAPI_DeviceDriver *driver = SDL_HIDAPI_drivers[i];
if (driver->enabled) {
++SDL_HIDAPI_numdrivers;
}
}
551
/* Update device list if driver availability changes */
552
SDL_LockJoysticks();
553
554
for (device = SDL_HIDAPI_devices; device; device = device->next) {
555
556
if (device->driver && !device->driver->enabled) {
HIDAPI_CleanupDeviceDriver(device);
557
}
558
HIDAPI_SetupDeviceDriver(device);
559
560
}
561
SDL_UnlockJoysticks();
562
}
563
564
565
566
567
568
static int
HIDAPI_JoystickInit(void)
{
int i;
569
570
571
572
if (initialized) {
return 0;
}
573
574
#if defined(__MACOSX__) || defined(__IPHONEOS__) || defined(__TVOS__)
/* The hidapi framwork is weak-linked on Apple platforms */
575
576
577
578
579
580
int HID_API_EXPORT HID_API_CALL hid_init(void) __attribute__((weak_import));
if (hid_init == NULL) {
SDL_SetError("Couldn't initialize hidapi, framework not available");
return -1;
}
581
#endif /* __MACOSX__ || __IPHONEOS__ || __TVOS__ */
582
583
584
585
586
587
if (hid_init() < 0) {
SDL_SetError("Couldn't initialize hidapi");
return -1;
}
588
589
590
591
592
#ifdef __WINDOWS__
/* On Windows, turns out HIDAPI for Xbox controllers doesn't allow background input, so off by default */
SDL_SetHintWithPriority(SDL_HINT_JOYSTICK_HIDAPI_XBOX, "0", SDL_HINT_DEFAULT);
#endif
593
594
595
596
597
598
for (i = 0; i < SDL_arraysize(SDL_HIDAPI_drivers); ++i) {
SDL_HIDAPI_DeviceDriver *driver = SDL_HIDAPI_drivers[i];
SDL_AddHintCallback(driver->hint, SDL_HIDAPIDriverHintChanged, NULL);
}
SDL_AddHintCallback(SDL_HINT_JOYSTICK_HIDAPI,
SDL_HIDAPIDriverHintChanged, NULL);
599
HIDAPI_InitializeDiscovery();
600
HIDAPI_JoystickDetect();
601
HIDAPI_UpdateDevices();
602
603
604
initialized = SDL_TRUE;
605
606
607
return 0;
}
608
SDL_bool
609
HIDAPI_JoystickConnected(SDL_HIDAPI_Device *device, SDL_JoystickID *pJoystickID, SDL_bool is_external)
610
611
612
613
614
615
616
617
618
619
{
SDL_JoystickID joystickID;
SDL_JoystickID *joysticks = (SDL_JoystickID *)SDL_realloc(device->joysticks, (device->num_joysticks + 1)*sizeof(*device->joysticks));
if (!joysticks) {
return SDL_FALSE;
}
joystickID = SDL_GetNextJoystickInstanceID();
device->joysticks = joysticks;
device->joysticks[device->num_joysticks++] = joystickID;
620
621
622
if (!is_external) {
++SDL_HIDAPI_numjoysticks;
}
623
624
625
626
627
628
629
630
631
632
SDL_PrivateJoystickAdded(joystickID);
if (pJoystickID) {
*pJoystickID = joystickID;
}
return SDL_TRUE;
}
void
633
HIDAPI_JoystickDisconnected(SDL_HIDAPI_Device *device, SDL_JoystickID joystickID, SDL_bool is_external)
634
635
636
637
638
{
int i;
for (i = 0; i < device->num_joysticks; ++i) {
if (device->joysticks[i] == joystickID) {
639
SDL_Joystick *joystick = SDL_JoystickFromInstanceID(joystickID);
640
if (joystick && !is_external) {
641
642
643
HIDAPI_JoystickClose(joystick);
}
644
SDL_memmove(&device->joysticks[i], &device->joysticks[i+1], device->num_joysticks - i - 1);
645
--device->num_joysticks;
646
647
648
if (!is_external) {
--SDL_HIDAPI_numjoysticks;
}
649
650
651
652
if (device->num_joysticks == 0) {
SDL_free(device->joysticks);
device->joysticks = NULL;
}
653
654
655
656
657
658
659
660
661
if (!shutting_down) {
SDL_PrivateJoystickRemoved(joystickID);
}
return;
}
}
}
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
static int
HIDAPI_JoystickGetCount(void)
{
return SDL_HIDAPI_numjoysticks;
}
static void
HIDAPI_AddDevice(struct hid_device_info *info)
{
SDL_HIDAPI_Device *device;
SDL_HIDAPI_Device *curr, *last = NULL;
for (curr = SDL_HIDAPI_devices, last = NULL; curr; last = curr, curr = curr->next) {
continue;
}
device = (SDL_HIDAPI_Device *)SDL_calloc(1, sizeof(*device));
if (!device) {
return;
}
682
683
684
685
686
device->path = SDL_strdup(info->path);
if (!device->path) {
SDL_free(device);
return;
}
687
688
689
device->seen = SDL_TRUE;
device->vendor_id = info->vendor_id;
device->product_id = info->product_id;
690
device->version = info->release_number;
691
device->interface_number = info->interface_number;
692
693
694
device->interface_class = info->interface_class;
device->interface_subclass = info->interface_subclass;
device->interface_protocol = info->interface_protocol;
695
696
697
698
699
700
device->usage_page = info->usage_page;
device->usage = info->usage;
{
/* FIXME: Is there any way to tell whether this is a Bluetooth device? */
const Uint16 vendor = device->vendor_id;
const Uint16 product = device->product_id;
701
const Uint16 version = device->version;
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
Uint16 *guid16 = (Uint16 *)device->guid.data;
*guid16++ = SDL_SwapLE16(SDL_HARDWARE_BUS_USB);
*guid16++ = 0;
*guid16++ = SDL_SwapLE16(vendor);
*guid16++ = 0;
*guid16++ = SDL_SwapLE16(product);
*guid16++ = 0;
*guid16++ = SDL_SwapLE16(version);
*guid16++ = 0;
/* Note that this is a HIDAPI device for special handling elsewhere */
device->guid.data[14] = 'h';
device->guid.data[15] = 0;
}
717
device->dev_lock = SDL_CreateMutex();
718
719
/* Need the device name before getting the driver to know whether to ignore this device */
720
{
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
char *manufacturer_string = NULL;
char *product_string = NULL;
if (info->manufacturer_string) {
manufacturer_string = SDL_iconv_string("UTF-8", "WCHAR_T", (char*)info->manufacturer_string, (SDL_wcslen(info->manufacturer_string)+1)*sizeof(wchar_t));
if (!manufacturer_string) {
if (sizeof(wchar_t) == sizeof(Uint16)) {
manufacturer_string = SDL_iconv_string("UTF-8", "UCS-2-INTERNAL", (char*)info->manufacturer_string, (SDL_wcslen(info->manufacturer_string)+1)*sizeof(wchar_t));
} else if (sizeof(wchar_t) == sizeof(Uint32)) {
manufacturer_string = SDL_iconv_string("UTF-8", "UCS-4-INTERNAL", (char*)info->manufacturer_string, (SDL_wcslen(info->manufacturer_string)+1)*sizeof(wchar_t));
}
}
}
if (info->product_string) {
product_string = SDL_iconv_string("UTF-8", "WCHAR_T", (char*)info->product_string, (SDL_wcslen(info->product_string)+1)*sizeof(wchar_t));
if (!product_string) {
if (sizeof(wchar_t) == sizeof(Uint16)) {
product_string = SDL_iconv_string("UTF-8", "UCS-2-INTERNAL", (char*)info->product_string, (SDL_wcslen(info->product_string)+1)*sizeof(wchar_t));
} else if (sizeof(wchar_t) == sizeof(Uint32)) {
product_string = SDL_iconv_string("UTF-8", "UCS-4-INTERNAL", (char*)info->product_string, (SDL_wcslen(info->product_string)+1)*sizeof(wchar_t));
}
742
743
}
}
744
745
device->name = SDL_CreateJoystickName(device->vendor_id, device->product_id, manufacturer_string, product_string);
746
747
748
749
750
751
752
if (manufacturer_string) {
SDL_free(manufacturer_string);
}
if (product_string) {
SDL_free(product_string);
}
753
754
if (!device->name) {
755
SDL_free(device->path);
756
757
758
759
760
761
762
763
764
765
766
767
SDL_free(device);
return;
}
}
/* Add it to the list */
if (last) {
last->next = device;
} else {
SDL_HIDAPI_devices = device;
}
768
769
HIDAPI_SetupDeviceDriver(device);
770
#ifdef DEBUG_HIDAPI
771
SDL_Log("Added HIDAPI device '%s' VID 0x%.4x, PID 0x%.4x, version %d, interface %d, interface_class %d, interface_subclass %d, interface_protocol %d, usage page 0x%.4x, usage 0x%.4x, path = %s, driver = %s (%s)\n", device->name, device->vendor_id, device->product_id, device->version, device->interface_number, device->interface_class, device->interface_subclass, device->interface_protocol, device->usage_page, device->usage, device->path, device->driver ? device->driver->hint : "NONE", device->driver && device->driver->enabled ? "ENABLED" : "DISABLED");
772
#endif
773
774
775
776
}
static void
777
HIDAPI_DelDevice(SDL_HIDAPI_Device *device)
778
779
780
781
782
783
784
785
786
787
{
SDL_HIDAPI_Device *curr, *last;
for (curr = SDL_HIDAPI_devices, last = NULL; curr; last = curr, curr = curr->next) {
if (curr == device) {
if (last) {
last->next = curr->next;
} else {
SDL_HIDAPI_devices = curr->next;
}
788
HIDAPI_CleanupDeviceDriver(device);
789
790
SDL_DestroyMutex(device->dev_lock);
791
792
793
794
795
796
797
798
799
800
801
802
803
804
SDL_free(device->name);
SDL_free(device->path);
SDL_free(device);
return;
}
}
}
static void
HIDAPI_UpdateDeviceList(void)
{
SDL_HIDAPI_Device *device;
struct hid_device_info *devs, *info;
805
SDL_LockJoysticks();
806
807
808
809
810
811
812
813
814
/* Prepare the existing device list */
device = SDL_HIDAPI_devices;
while (device) {
device->seen = SDL_FALSE;
device = device->next;
}
/* Enumerate the devices */
815
816
817
818
819
820
821
822
823
824
if (SDL_HIDAPI_numdrivers > 0) {
devs = hid_enumerate(0, 0);
if (devs) {
for (info = devs; info; info = info->next) {
device = HIDAPI_GetJoystickByInfo(info->path, info->vendor_id, info->product_id);
if (device) {
device->seen = SDL_TRUE;
} else {
HIDAPI_AddDevice(info);
}
825
}
826
hid_free_enumeration(devs);
827
828
829
830
831
832
833
834
835
}
}
/* Remove any devices that weren't seen */
device = SDL_HIDAPI_devices;
while (device) {
SDL_HIDAPI_Device *next = device->next;
if (!device->seen) {
836
HIDAPI_DelDevice(device);
837
838
839
}
device = next;
}
840
841
SDL_UnlockJoysticks();
842
843
844
}
SDL_bool
845
HIDAPI_IsDevicePresent(Uint16 vendor_id, Uint16 product_id, Uint16 version, const char *name)
846
847
{
SDL_HIDAPI_Device *device;
848
SDL_bool supported = SDL_FALSE;
849
SDL_bool result = SDL_FALSE;
850
851
852
853
854
855
/* Make sure we're initialized, as this could be called from other drivers during startup */
if (HIDAPI_JoystickInit() < 0) {
return SDL_FALSE;
}
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
/* Only update the device list for devices we know might be supported.
If we did this for every device, it would hit the USB driver too hard and potentially
lock up the system. This won't catch devices that we support but can only detect using
USB interface details, like Xbox controllers, but hopefully the device list update is
responsive enough to catch those.
*/
supported = HIDAPI_IsDeviceSupported(vendor_id, product_id, version, name);
#if defined(SDL_JOYSTICK_HIDAPI_XBOX360) || defined(SDL_JOYSTICK_HIDAPI_XBOXONE)
if (!supported &&
(SDL_strstr(name, "Xbox") || SDL_strstr(name, "X-Box") || SDL_strstr(name, "XBOX"))) {
supported = SDL_TRUE;
}
#endif /* SDL_JOYSTICK_HIDAPI_XBOX360 || SDL_JOYSTICK_HIDAPI_XBOXONE */
if (supported) {
if (SDL_AtomicTryLock(&SDL_HIDAPI_spinlock)) {
HIDAPI_UpdateDeviceList();
SDL_AtomicUnlock(&SDL_HIDAPI_spinlock);
}
874
}
875
876
877
878
879
/* Note that this isn't a perfect check - there may be multiple devices with 0 VID/PID,
or a different name than we have it listed here, etc, but if we support the device
and we have something similar in our device list, mark it as present.
*/
880
SDL_LockJoysticks();
881
882
883
device = SDL_HIDAPI_devices;
while (device) {
if (device->vendor_id == vendor_id && device->product_id == product_id && device->driver) {
884
result = SDL_TRUE;
885
886
887
}
device = device->next;
}
888
889
SDL_UnlockJoysticks();
890
/* If we're looking for the wireless XBox 360 controller, also look for the dongle */
891
892
if (!result && vendor_id == USB_VENDOR_MICROSOFT && product_id == 0x02a1) {
return HIDAPI_IsDevicePresent(USB_VENDOR_MICROSOFT, 0x0719, version, name);
893
894
895
896
897
}
#ifdef DEBUG_HIDAPI
SDL_Log("HIDAPI_IsDevicePresent() returning %s for 0x%.4x / 0x%.4x\n", result ? "true" : "false", vendor_id, product_id);
#endif
898
return result;
899
900
901
902
903
}
static void
HIDAPI_JoystickDetect(void)
{
904
int i;
905
906
907
908
909
910
911
912
if (SDL_AtomicTryLock(&SDL_HIDAPI_spinlock)) {
HIDAPI_UpdateDiscovery();
if (SDL_HIDAPI_discovery.m_bHaveDevicesChanged) {
/* FIXME: We probably need to schedule an update in a few seconds as well */
HIDAPI_UpdateDeviceList();
SDL_HIDAPI_discovery.m_bHaveDevicesChanged = SDL_FALSE;
}
SDL_AtomicUnlock(&SDL_HIDAPI_spinlock);
913
}
914
915
916
917
918
919
for (i = 0; i < SDL_arraysize(SDL_HIDAPI_drivers); ++i) {
SDL_HIDAPI_DeviceDriver *driver = SDL_HIDAPI_drivers[i];
if (driver->enabled && driver->PostUpdate) {
driver->PostUpdate();
}
}
920
921
922
923
924
925
}
void
HIDAPI_UpdateDevices(void)
{
SDL_HIDAPI_Device *device;
926
927
928
929
/* Update the devices, which may change connected joysticks and send events */
/* Prepare the existing device list */
930
931
932
933
if (SDL_AtomicTryLock(&SDL_HIDAPI_spinlock)) {
device = SDL_HIDAPI_devices;
while (device) {
if (device->driver) {
934
935
936
937
if (SDL_TryLockMutex(device->dev_lock) == 0) {
device->driver->UpdateDevice(device);
SDL_UnlockMutex(device->dev_lock);
}
938
939
}
device = device->next;
940
}
941
SDL_AtomicUnlock(&SDL_HIDAPI_spinlock);
942
}
943
944
945
946
947
}
static const char *
HIDAPI_JoystickGetDeviceName(int device_index)
{
948
949
950
951
952
953
954
955
956
957
SDL_HIDAPI_Device *device;
const char *name = NULL;
device = HIDAPI_GetDeviceByIndex(device_index, NULL);
if (device) {
/* FIXME: The device could be freed after this name is returned... */
name = device->name;
}
return name;
958
959
}
960
961
962
static int
HIDAPI_JoystickGetDevicePlayerIndex(int device_index)
{
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
SDL_HIDAPI_Device *device;
SDL_JoystickID instance_id;
int player_index = -1;
device = HIDAPI_GetDeviceByIndex(device_index, &instance_id);
if (device) {
player_index = device->driver->GetDevicePlayerIndex(device, instance_id);
}
return player_index;
}
static void
HIDAPI_JoystickSetDevicePlayerIndex(int device_index, int player_index)
{
SDL_HIDAPI_Device *device;
SDL_JoystickID instance_id;
device = HIDAPI_GetDeviceByIndex(device_index, &instance_id);
if (device) {
device->driver->SetDevicePlayerIndex(device, instance_id, player_index);
}
985
986
}
987
988
989
static SDL_JoystickGUID
HIDAPI_JoystickGetDeviceGUID(int device_index)
{
990
991
992
993
994
995
996
997
998
999
1000
SDL_HIDAPI_Device *device;
SDL_JoystickGUID guid;
device = HIDAPI_GetDeviceByIndex(device_index, NULL);
if (device) {
SDL_memcpy(&guid, &device->guid, sizeof(guid));
} else {
SDL_zero(guid);
}
return guid;