This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_sysjoystick.c
1139 lines (986 loc) · 39.2 KB
1
2
/*
Simple DirectMedia Layer
3
Copyright (C) 1997-2013 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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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_config.h"
#ifdef SDL_JOYSTICK_IOKIT
/* SDL joystick driver for Darwin / Mac OS X, based on the IOKit HID API */
/* Written 2001 by Max Horn */
#include <unistd.h>
#include <ctype.h>
#include <sysexits.h>
#include <mach/mach.h>
#include <mach/mach_error.h>
#include <IOKit/IOKitLib.h>
#include <IOKit/IOCFPlugIn.h>
#ifdef MACOS_10_0_4
#include <IOKit/hidsystem/IOHIDUsageTables.h>
#else
/* The header was moved here in Mac OS X 10.1 */
#include <Kernel/IOKit/hidsystem/IOHIDUsageTables.h>
#endif
#include <IOKit/hid/IOHIDLib.h>
#include <IOKit/hid/IOHIDKeys.h>
#include <CoreFoundation/CoreFoundation.h>
#include <Carbon/Carbon.h> /* for NewPtrClear, DisposePtr */
45
#include <IOKit/IOMessage.h>
46
47
48
49
50
51
52
53
54
/* For force feedback testing. */
#include <ForceFeedback/ForceFeedback.h>
#include <ForceFeedback/ForceFeedbackConstants.h>
#include "SDL_joystick.h"
#include "../SDL_sysjoystick.h"
#include "../SDL_joystick_c.h"
#include "SDL_sysjoystick_c.h"
55
56
57
58
#include "SDL_events.h"
#if !SDL_EVENTS_DISABLED
#include "../../events/SDL_events_c.h"
#endif
59
60
61
62
/* Linked list of all available devices */
static recDevice *gpDeviceList = NULL;
63
64
65
/* OSX reference to the notification object that tells us about device insertion/removal */
IONotificationPortRef notificationPort = 0;
/* if 1 then a device was added since the last update call */
66
static SDL_bool s_bDeviceAdded = SDL_FALSE;
67
static SDL_bool s_bDeviceRemoved = SDL_FALSE;
68
69
70
/* static incrementing counter for new joystick devices seen on the system. Devices should start with index 0 */
static int s_joystick_instance_id = -1;
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
static void
HIDReportErrorNum(char *strError, long numError)
{
SDL_SetError(strError);
}
static void HIDGetCollectionElements(CFMutableDictionaryRef deviceProperties,
recDevice * pDevice);
/* returns current value for element, polling element
* will return 0 on error conditions which should be accounted for by application
*/
static SInt32
HIDGetElementValue(recDevice * pDevice, recElement * pElement)
{
IOReturn result = kIOReturnSuccess;
IOHIDEventStruct hidEvent;
hidEvent.value = 0;
if (NULL != pDevice && NULL != pElement && NULL != pDevice->interface) {
result =
(*(pDevice->interface))->getElementValue(pDevice->interface,
pElement->cookie,
&hidEvent);
if (kIOReturnSuccess == result) {
/* record min and max for auto calibration */
if (hidEvent.value < pElement->minReport)
pElement->minReport = hidEvent.value;
if (hidEvent.value > pElement->maxReport)
pElement->maxReport = hidEvent.value;
}
}
/* auto user scale */
return hidEvent.value;
}
static SInt32
HIDScaledCalibratedValue(recDevice * pDevice, recElement * pElement,
long min, long max)
{
float deviceScale = max - min;
float readScale = pElement->maxReport - pElement->minReport;
SInt32 value = HIDGetElementValue(pDevice, pElement);
if (readScale == 0)
return value; /* no scaling at all */
else
return ((value - pElement->minReport) * deviceScale / readScale) +
min;
}
static void
HIDRemovalCallback(void *target, IOReturn result, void *refcon, void *sender)
{
recDevice *device = (recDevice *) refcon;
device->removed = 1;
130
s_bDeviceRemoved = SDL_TRUE;
131
132
133
}
134
135
136
137
138
139
/* Called by the io port notifier on removal of this device
*/
void JoystickDeviceWasRemovedCallback( void * refcon, io_service_t service, natural_t messageType, void * messageArgument )
{
if( messageType == kIOMessageServiceIsTerminated && refcon )
{
140
141
142
143
recDevice *device = (recDevice *) refcon;
device->removed = 1;
s_bDeviceRemoved = SDL_TRUE;
}
144
145
}
146
147
/* Create and open an interface to device, required prior to extracting values or building queues.
148
* Note: application now owns the device and must close and release it prior to exiting
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
*/
static IOReturn
HIDCreateOpenDeviceInterface(io_object_t hidDevice, recDevice * pDevice)
{
IOReturn result = kIOReturnSuccess;
HRESULT plugInResult = S_OK;
SInt32 score = 0;
IOCFPlugInInterface **ppPlugInInterface = NULL;
if (NULL == pDevice->interface) {
result =
IOCreatePlugInInterfaceForService(hidDevice,
kIOHIDDeviceUserClientTypeID,
kIOCFPlugInInterfaceID,
&ppPlugInInterface, &score);
if (kIOReturnSuccess == result) {
/* Call a method of the intermediate plug-in to create the device interface */
plugInResult =
(*ppPlugInInterface)->QueryInterface(ppPlugInInterface,
CFUUIDGetUUIDBytes
(kIOHIDDeviceInterfaceID),
(void *)
&(pDevice->interface));
if (S_OK != plugInResult)
HIDReportErrorNum
175
("Couldn't query HID class device interface from plugInInterface",
176
177
178
179
180
181
182
183
184
185
186
187
188
plugInResult);
(*ppPlugInInterface)->Release(ppPlugInInterface);
} else
HIDReportErrorNum
("Failed to create **plugInInterface via IOCreatePlugInInterfaceForService.",
result);
}
if (NULL != pDevice->interface) {
result = (*(pDevice->interface))->open(pDevice->interface, 0);
if (kIOReturnSuccess != result)
HIDReportErrorNum
("Failed to open pDevice->interface via open.", result);
else
189
190
{
pDevice->portIterator = 0;
191
192
/* It's okay if this fails, we have another detection method below */
193
194
195
(*(pDevice->interface))->setRemovalCallback(pDevice->interface,
HIDRemovalCallback,
pDevice, pDevice);
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/* now connect notification for new devices */
pDevice->notificationPort = IONotificationPortCreate(kIOMasterPortDefault);
CFRunLoopAddSource(CFRunLoopGetCurrent(),
IONotificationPortGetRunLoopSource(pDevice->notificationPort),
kCFRunLoopDefaultMode);
/* Register for notifications when a serial port is added to the system */
result = IOServiceAddInterestNotification(pDevice->notificationPort,
hidDevice,
kIOGeneralInterest,
JoystickDeviceWasRemovedCallback,
pDevice,
&pDevice->portIterator);
if (kIOReturnSuccess != result) {
HIDReportErrorNum
("Failed to register for removal callback.", result);
}
}
216
217
218
219
220
}
return result;
}
221
/* Closes and releases interface to device, should be done prior to exiting application
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
* Note: will have no affect if device or interface do not exist
* application will "own" the device if interface is not closed
* (device may have to be plug and re-plugged in different location to get it working again without a restart)
*/
static IOReturn
HIDCloseReleaseInterface(recDevice * pDevice)
{
IOReturn result = kIOReturnSuccess;
if ((NULL != pDevice) && (NULL != pDevice->interface)) {
/* close the interface */
result = (*(pDevice->interface))->close(pDevice->interface);
if (kIOReturnNotOpen == result) {
/* do nothing as device was not opened, thus can't be closed */
} else if (kIOReturnSuccess != result)
HIDReportErrorNum("Failed to close IOHIDDeviceInterface.",
result);
/* release the interface */
result = (*(pDevice->interface))->Release(pDevice->interface);
if (kIOReturnSuccess != result)
HIDReportErrorNum("Failed to release IOHIDDeviceInterface.",
result);
pDevice->interface = NULL;
246
247
248
249
250
251
if ( pDevice->portIterator )
{
IOObjectRelease( pDevice->portIterator );
pDevice->portIterator = 0;
}
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
}
return result;
}
/* extracts actual specific element information from each element CF dictionary entry */
static void
HIDGetElementInfo(CFTypeRef refElement, recElement * pElement)
{
long number;
CFTypeRef refType;
refType = CFDictionaryGetValue(refElement, CFSTR(kIOHIDElementCookieKey));
if (refType && CFNumberGetValue(refType, kCFNumberLongType, &number))
pElement->cookie = (IOHIDElementCookie) number;
refType = CFDictionaryGetValue(refElement, CFSTR(kIOHIDElementMinKey));
if (refType && CFNumberGetValue(refType, kCFNumberLongType, &number))
pElement->minReport = pElement->min = number;
pElement->maxReport = pElement->min;
refType = CFDictionaryGetValue(refElement, CFSTR(kIOHIDElementMaxKey));
if (refType && CFNumberGetValue(refType, kCFNumberLongType, &number))
pElement->maxReport = pElement->max = number;
/*
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
TODO: maybe should handle the following stuff somehow?
refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementScaledMinKey));
if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number))
pElement->scaledMin = number;
refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementScaledMaxKey));
if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number))
pElement->scaledMax = number;
refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementSizeKey));
if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number))
pElement->size = number;
refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementIsRelativeKey));
if (refType)
pElement->relative = CFBooleanGetValue (refType);
refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementIsWrappingKey));
if (refType)
pElement->wrapping = CFBooleanGetValue (refType);
refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementIsNonLinearKey));
if (refType)
pElement->nonLinear = CFBooleanGetValue (refType);
refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementHasPreferedStateKey));
if (refType)
pElement->preferredState = CFBooleanGetValue (refType);
refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementHasNullStateKey));
if (refType)
pElement->nullState = CFBooleanGetValue (refType);
301
302
303
*/
}
304
/* examines CF dictionary value in device element hierarchy to determine if it is element of interest or a collection of more elements
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
* if element of interest allocate storage, add to list and retrieve element specific info
* if collection then pass on to deconstruction collection into additional individual elements
*/
static void
HIDAddElement(CFTypeRef refElement, recDevice * pDevice)
{
recElement *element = NULL;
recElement **headElement = NULL;
long elementType, usagePage, usage;
CFTypeRef refElementType =
CFDictionaryGetValue(refElement, CFSTR(kIOHIDElementTypeKey));
CFTypeRef refUsagePage =
CFDictionaryGetValue(refElement, CFSTR(kIOHIDElementUsagePageKey));
CFTypeRef refUsage =
CFDictionaryGetValue(refElement, CFSTR(kIOHIDElementUsageKey));
if ((refElementType)
&&
(CFNumberGetValue(refElementType, kCFNumberLongType, &elementType))) {
/* look at types of interest */
if ((elementType == kIOHIDElementTypeInput_Misc)
|| (elementType == kIOHIDElementTypeInput_Button)
|| (elementType == kIOHIDElementTypeInput_Axis)) {
if (refUsagePage
&& CFNumberGetValue(refUsagePage, kCFNumberLongType,
&usagePage) && refUsage
&& CFNumberGetValue(refUsage, kCFNumberLongType, &usage)) {
switch (usagePage) { /* only interested in kHIDPage_GenericDesktop and kHIDPage_Button */
case kHIDPage_GenericDesktop:
{
switch (usage) { /* look at usage to determine function */
case kHIDUsage_GD_X:
case kHIDUsage_GD_Y:
case kHIDUsage_GD_Z:
case kHIDUsage_GD_Rx:
case kHIDUsage_GD_Ry:
case kHIDUsage_GD_Rz:
case kHIDUsage_GD_Slider:
case kHIDUsage_GD_Dial:
case kHIDUsage_GD_Wheel:
element = (recElement *)
NewPtrClear(sizeof(recElement));
if (element) {
pDevice->axes++;
headElement = &(pDevice->firstAxis);
}
break;
case kHIDUsage_GD_Hatswitch:
element = (recElement *)
NewPtrClear(sizeof(recElement));
if (element) {
pDevice->hats++;
headElement = &(pDevice->firstHat);
}
break;
}
}
break;
case kHIDPage_Button:
element = (recElement *)
NewPtrClear(sizeof(recElement));
if (element) {
pDevice->buttons++;
headElement = &(pDevice->firstButton);
}
break;
default:
break;
}
}
} else if (kIOHIDElementTypeCollection == elementType)
HIDGetCollectionElements((CFMutableDictionaryRef) refElement,
pDevice);
}
if (element && headElement) { /* add to list */
recElement *elementPrevious = NULL;
recElement *elementCurrent = *headElement;
while (elementCurrent && usage >= elementCurrent->usage) {
elementPrevious = elementCurrent;
elementCurrent = elementCurrent->pNext;
}
if (elementPrevious) {
elementPrevious->pNext = element;
} else {
*headElement = element;
}
element->usagePage = usagePage;
element->usage = usage;
element->pNext = elementCurrent;
HIDGetElementInfo(refElement, element);
pDevice->elements++;
}
}
402
/* collects information from each array member in device element list (each array member = element) */
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
static void
HIDGetElementsCFArrayHandler(const void *value, void *parameter)
{
if (CFGetTypeID(value) == CFDictionaryGetTypeID())
HIDAddElement((CFTypeRef) value, (recDevice *) parameter);
}
/* handles retrieval of element information from arrays of elements in device IO registry information */
static void
HIDGetElements(CFTypeRef refElementCurrent, recDevice * pDevice)
{
CFTypeID type = CFGetTypeID(refElementCurrent);
if (type == CFArrayGetTypeID()) { /* if element is an array */
CFRange range = { 0, CFArrayGetCount(refElementCurrent) };
/* CountElementsCFArrayHandler called for each array member */
CFArrayApplyFunction(refElementCurrent, range,
HIDGetElementsCFArrayHandler, pDevice);
}
}
/* handles extracting element information from element collection CF types
* used from top level element decoding and hierarchy deconstruction to flatten device element list
*/
static void
HIDGetCollectionElements(CFMutableDictionaryRef deviceProperties,
recDevice * pDevice)
{
CFTypeRef refElementTop =
CFDictionaryGetValue(deviceProperties, CFSTR(kIOHIDElementKey));
if (refElementTop)
HIDGetElements(refElementTop, pDevice);
}
/* use top level element usage page and usage to discern device usage page and usage setting appropriate vlaues in device record */
static void
HIDTopLevelElementHandler(const void *value, void *parameter)
{
CFTypeRef refCF = 0;
if (CFGetTypeID(value) != CFDictionaryGetTypeID())
return;
refCF = CFDictionaryGetValue(value, CFSTR(kIOHIDElementUsagePageKey));
if (!CFNumberGetValue
(refCF, kCFNumberLongType, &((recDevice *) parameter)->usagePage))
SDL_SetError("CFNumberGetValue error retrieving pDevice->usagePage.");
refCF = CFDictionaryGetValue(value, CFSTR(kIOHIDElementUsageKey));
if (!CFNumberGetValue
(refCF, kCFNumberLongType, &((recDevice *) parameter)->usage))
SDL_SetError("CFNumberGetValue error retrieving pDevice->usage.");
}
/* extracts device info from CF dictionary records in IO registry */
static void
HIDGetDeviceInfo(io_object_t hidDevice, CFMutableDictionaryRef hidProperties,
recDevice * pDevice)
{
CFMutableDictionaryRef usbProperties = 0;
io_registry_entry_t parent1, parent2;
/* Mac OS X currently is not mirroring all USB properties to HID page so need to look at USB device page also
467
* get dictionary for USB properties: step up two levels and get CF dictionary for USB properties
468
*/
469
470
471
if ((KERN_SUCCESS == IORegistryEntryGetParentEntry(hidDevice, kIOServicePlane, &parent1))
&& (KERN_SUCCESS == IORegistryEntryGetParentEntry(parent1, kIOServicePlane, &parent2))
&& (KERN_SUCCESS == IORegistryEntryCreateCFProperties(parent2, &usbProperties, kCFAllocatorDefault, kNilOptions))) {
472
473
474
475
476
477
478
if (usbProperties) {
CFTypeRef refCF = 0;
/* get device info
* try hid dictionary first, if fail then go to usb dictionary
*/
/* get product name */
479
480
481
482
refCF = CFDictionaryGetValue(hidProperties, CFSTR(kIOHIDProductKey));
if (!refCF) {
refCF = CFDictionaryGetValue(usbProperties, CFSTR("USB Product Name"));
}
483
if (refCF) {
484
485
486
if (!CFStringGetCString(refCF, pDevice->product, 256, CFStringGetSystemEncoding())) {
SDL_SetError("CFStringGetCString error retrieving pDevice->product.");
}
487
488
489
}
/* get usage page and usage */
490
refCF = CFDictionaryGetValue(hidProperties, CFSTR(kIOHIDPrimaryUsagePageKey));
491
if (refCF) {
492
493
494
495
496
497
498
499
500
501
if (!CFNumberGetValue (refCF, kCFNumberLongType, &pDevice->usagePage)) {
SDL_SetError("CFNumberGetValue error retrieving pDevice->usagePage.");
}
refCF = CFDictionaryGetValue(hidProperties, CFSTR(kIOHIDPrimaryUsageKey));
if (refCF) {
if (!CFNumberGetValue (refCF, kCFNumberLongType, &pDevice->usage)) {
SDL_SetError("CFNumberGetValue error retrieving pDevice->usage.");
}
}
502
503
}
504
refCF = CFDictionaryGetValue(hidProperties, CFSTR(kIOHIDVendorIDKey));
505
if (refCF) {
506
507
508
if (!CFNumberGetValue(refCF, kCFNumberLongType, &pDevice->guid.data[0])) {
SDL_SetError("CFNumberGetValue error retrieving pDevice->guid[0]");
}
509
}
510
511
refCF = CFDictionaryGetValue(hidProperties, CFSTR(kIOHIDProductIDKey));
512
if (refCF) {
513
514
515
if (!CFNumberGetValue(refCF, kCFNumberLongType, &pDevice->guid.data[8])) {
SDL_SetError("CFNumberGetValue error retrieving pDevice->guid[8]");
}
516
517
}
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
/* Check to make sure we have a vendor and product ID
If we don't, use the same algorithm as the Linux code for Bluetooth devices */
{
Uint32 *guid32 = (Uint32*)pDevice->guid.data;
if (!guid32[0] && !guid32[1]) {
const Uint16 BUS_BLUETOOTH = 0x05;
Uint16 *guid16 = (Uint16 *)guid32;
*guid16++ = BUS_BLUETOOTH;
*guid16++ = 0;
SDL_strlcpy((char*)guid16, pDevice->product, sizeof(pDevice->guid.data) - 4);
}
}
/* If we don't have a vendor and product ID this is probably a Bluetooth device */
if (NULL == refCF) { /* get top level element HID usage page or usage */
534
535
/* use top level element instead */
CFTypeRef refCFTopElement = 0;
536
refCFTopElement = CFDictionaryGetValue(hidProperties, CFSTR(kIOHIDElementKey));
537
538
539
{
/* refCFTopElement points to an array of element dictionaries */
CFRange range = { 0, CFArrayGetCount(refCFTopElement) };
540
CFArrayApplyFunction(refCFTopElement, range, HIDTopLevelElementHandler, pDevice);
541
542
543
544
}
}
CFRelease(usbProperties);
545
546
547
} else {
SDL_SetError("IORegistryEntryCreateCFProperties failed to create usbProperties.");
}
548
549
550
551
552
553
554
if (kIOReturnSuccess != IOObjectRelease(parent2)) {
SDL_SetError("IOObjectRelease error with parent2");
}
if (kIOReturnSuccess != IOObjectRelease(parent1)) {
SDL_SetError("IOObjectRelease error with parent1");
}
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
}
}
static recDevice *
HIDBuildDevice(io_object_t hidDevice)
{
recDevice *pDevice = (recDevice *) NewPtrClear(sizeof(recDevice));
if (pDevice) {
/* get dictionary for HID properties */
CFMutableDictionaryRef hidProperties = 0;
kern_return_t result =
IORegistryEntryCreateCFProperties(hidDevice, &hidProperties,
kCFAllocatorDefault,
kNilOptions);
if ((result == KERN_SUCCESS) && hidProperties) {
/* create device interface */
result = HIDCreateOpenDeviceInterface(hidDevice, pDevice);
if (kIOReturnSuccess == result) {
HIDGetDeviceInfo(hidDevice, hidProperties, pDevice); /* hidDevice used to find parents in registry tree */
HIDGetCollectionElements(hidProperties, pDevice);
576
pDevice->instance_id = ++s_joystick_instance_id;
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
} else {
DisposePtr((Ptr) pDevice);
pDevice = NULL;
}
CFRelease(hidProperties);
} else {
DisposePtr((Ptr) pDevice);
pDevice = NULL;
}
}
return pDevice;
}
/* disposes of the element list associated with a device and the memory associated with the list
*/
static void
HIDDisposeElementList(recElement ** elementList)
{
recElement *pElement = *elementList;
while (pElement) {
recElement *pElementNext = pElement->pNext;
DisposePtr((Ptr) pElement);
pElement = pElementNext;
}
*elementList = NULL;
}
/* disposes of a single device, closing and releaseing interface, freeing memory fro device and elements, setting device pointer to NULL
* all your device no longer belong to us... (i.e., you do not 'own' the device anymore)
*/
static recDevice *
HIDDisposeDevice(recDevice ** ppDevice)
{
kern_return_t result = KERN_SUCCESS;
recDevice *pDeviceNext = NULL;
if (*ppDevice) {
/* save next device prior to disposing of this device */
pDeviceNext = (*ppDevice)->pNext;
/* free posible io_service_t */
if ((*ppDevice)->ffservice) {
IOObjectRelease((*ppDevice)->ffservice);
(*ppDevice)->ffservice = 0;
}
/* free element lists */
HIDDisposeElementList(&(*ppDevice)->firstAxis);
HIDDisposeElementList(&(*ppDevice)->firstButton);
HIDDisposeElementList(&(*ppDevice)->firstHat);
result = HIDCloseReleaseInterface(*ppDevice); /* function sanity checks interface value (now application does not own device) */
if (kIOReturnSuccess != result)
HIDReportErrorNum
("HIDCloseReleaseInterface failed when trying to dipose device.",
result);
DisposePtr((Ptr) * ppDevice);
*ppDevice = NULL;
}
return pDeviceNext;
}
641
642
/* Given an io_object_t from OSX adds a joystick device to our list if appropriate
*/
643
int
644
645
646
AddDeviceHelper( io_object_t ioHIDDeviceObject )
{
recDevice *device;
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
/* build a device record */
device = HIDBuildDevice(ioHIDDeviceObject);
if (!device)
return 0;
/* Filter device list to non-keyboard/mouse stuff */
if ((device->usagePage != kHIDPage_GenericDesktop) ||
((device->usage != kHIDUsage_GD_Joystick &&
device->usage != kHIDUsage_GD_GamePad &&
device->usage != kHIDUsage_GD_MultiAxisController))) {
/* release memory for the device */
HIDDisposeDevice(&device);
DisposePtr((Ptr) device);
return 0;
}
/* We have to do some storage of the io_service_t for
* SDL_HapticOpenFromJoystick */
if (FFIsForceFeedback(ioHIDDeviceObject) == FF_OK) {
device->ffservice = ioHIDDeviceObject;
} else {
device->ffservice = 0;
}
device->send_open_event = 1;
s_bDeviceAdded = SDL_TRUE;
/* Add device to the end of the list */
if ( !gpDeviceList )
{
gpDeviceList = device;
}
else
{
recDevice *curdevice;
curdevice = gpDeviceList;
while ( curdevice->pNext )
{
curdevice = curdevice->pNext;
}
curdevice->pNext = device;
}
return 1;
694
695
696
697
698
699
700
701
702
}
/* Called by our IO port notifier on the master port when a HID device is inserted, we iterate
* and check for new joysticks
*/
void JoystickDeviceWasAddedCallback( void *refcon, io_iterator_t iterator )
{
io_object_t ioHIDDeviceObject = 0;
703
704
705
706
707
708
709
710
while ( ( ioHIDDeviceObject = IOIteratorNext(iterator) ) )
{
if ( ioHIDDeviceObject )
{
AddDeviceHelper( ioHIDDeviceObject );
}
}
711
}
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
/* Function to scan the system for joysticks.
* Joystick 0 should be the system default joystick.
* This function should return the number of available joysticks, or -1
* on an unrecoverable fatal error.
*/
int
SDL_SYS_JoystickInit(void)
{
IOReturn result = kIOReturnSuccess;
mach_port_t masterPort = 0;
io_iterator_t hidObjectIterator = 0;
CFMutableDictionaryRef hidMatchDictionary = NULL;
io_object_t ioHIDDeviceObject = 0;
727
io_iterator_t portIterator = 0;
728
729
if (gpDeviceList) {
730
return SDL_SetError("Joystick: Device list already inited.");
731
732
733
734
}
result = IOMasterPort(bootstrap_port, &masterPort);
if (kIOReturnSuccess != result) {
735
return SDL_SetError("Joystick: IOMasterPort error with bootstrap_port.");
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
}
/* Set up a matching dictionary to search I/O Registry by class name for all HID class devices. */
hidMatchDictionary = IOServiceMatching(kIOHIDDeviceKey);
if (hidMatchDictionary) {
/* Add key for device type (joystick, in this case) to refine the matching dictionary. */
/* NOTE: we now perform this filtering later
UInt32 usagePage = kHIDPage_GenericDesktop;
UInt32 usage = kHIDUsage_GD_Joystick;
CFNumberRef refUsage = NULL, refUsagePage = NULL;
refUsage = CFNumberCreate (kCFAllocatorDefault, kCFNumberIntType, &usage);
CFDictionarySetValue (hidMatchDictionary, CFSTR (kIOHIDPrimaryUsageKey), refUsage);
refUsagePage = CFNumberCreate (kCFAllocatorDefault, kCFNumberIntType, &usagePage);
CFDictionarySetValue (hidMatchDictionary, CFSTR (kIOHIDPrimaryUsagePageKey), refUsagePage);
*/
} else {
754
return SDL_SetError
755
756
757
758
759
760
761
762
763
("Joystick: Failed to get HID CFMutableDictionaryRef via IOServiceMatching.");
}
/*/ Now search I/O Registry for matching devices. */
result =
IOServiceGetMatchingServices(masterPort, hidMatchDictionary,
&hidObjectIterator);
/* Check for errors */
if (kIOReturnSuccess != result) {
764
return SDL_SetError("Joystick: Couldn't create a HID object iterator.");
765
766
767
768
769
770
771
772
773
}
if (!hidObjectIterator) { /* there are no joysticks */
gpDeviceList = NULL;
return 0;
}
/* IOServiceGetMatchingServices consumes a reference to the dictionary, so we don't need to release the dictionary ref. */
/* build flat linked list of devices from device iterator */
774
gpDeviceList = NULL;
775
776
while ((ioHIDDeviceObject = IOIteratorNext(hidObjectIterator))) {
777
AddDeviceHelper( ioHIDDeviceObject );
778
779
}
result = IOObjectRelease(hidObjectIterator); /* release the iterator */
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
/* now connect notification for new devices */
notificationPort = IONotificationPortCreate(masterPort);
hidMatchDictionary = IOServiceMatching(kIOHIDDeviceKey);
CFRunLoopAddSource(CFRunLoopGetCurrent(),
IONotificationPortGetRunLoopSource(notificationPort),
kCFRunLoopDefaultMode);
/* Register for notifications when a serial port is added to the system */
result = IOServiceAddMatchingNotification(notificationPort,
kIOFirstMatchNotification,
hidMatchDictionary,
JoystickDeviceWasAddedCallback,
NULL,
&portIterator);
while (IOIteratorNext(portIterator)) {}; /* Run out the iterator or notifications won't start (you can also use it to iterate the available devices). */
797
798
return SDL_SYS_NumJoysticks();
799
800
}
801
802
803
804
/* Function to return the number of joystick devices plugged in right now */
int
SDL_SYS_NumJoysticks()
{
805
recDevice *device = gpDeviceList;
806
int nJoySticks = 0;
807
808
809
810
811
while ( device )
{
if ( !device->removed )
nJoySticks++;
812
device = device->pNext;
813
}
814
815
return nJoySticks;
816
817
818
819
820
821
822
}
/* Function to cause any queued joystick insertions to be processed
*/
void
SDL_SYS_JoystickDetect()
{
823
824
825
826
827
828
829
830
831
832
833
834
if ( s_bDeviceAdded || s_bDeviceRemoved )
{
recDevice *device = gpDeviceList;
s_bDeviceAdded = SDL_FALSE;
s_bDeviceRemoved = SDL_FALSE;
int device_index = 0;
/* send notifications */
while ( device )
{
if ( device->send_open_event )
{
device->send_open_event = 0;
835
#if !SDL_EVENTS_DISABLED
836
837
838
839
840
841
842
843
844
845
SDL_Event event;
event.type = SDL_JOYDEVICEADDED;
if (SDL_GetEventState(event.type) == SDL_ENABLE) {
event.jdevice.which = device_index;
if ((SDL_EventOK == NULL)
|| (*SDL_EventOK) (SDL_EventOKParam, &event)) {
SDL_PushEvent(&event);
}
}
846
#endif /* !SDL_EVENTS_DISABLED */
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
}
if ( device->removed )
{
recDevice *removeDevice = device;
if ( gpDeviceList == removeDevice )
{
device = device->pNext;
gpDeviceList = device;
}
else
{
device = gpDeviceList;
while ( device->pNext != removeDevice )
{
device = device->pNext;
}
device->pNext = removeDevice->pNext;
}
869
#if !SDL_EVENTS_DISABLED
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
SDL_Event event;
event.type = SDL_JOYDEVICEREMOVED;
if (SDL_GetEventState(event.type) == SDL_ENABLE) {
event.jdevice.which = removeDevice->instance_id;
if ((SDL_EventOK == NULL)
|| (*SDL_EventOK) (SDL_EventOKParam, &event)) {
SDL_PushEvent(&event);
}
}
DisposePtr((Ptr) removeDevice);
#endif /* !SDL_EVENTS_DISABLED */
}
else
{
device = device->pNext;
device_index++;
}
}
}
892
893
894
895
896
}
SDL_bool
SDL_SYS_JoystickNeedsPolling()
{
897
return s_bDeviceAdded || s_bDeviceRemoved;
898
899
}
900
901
/* Function to get the device-dependent name of a joystick */
const char *
902
SDL_SYS_JoystickNameForDeviceIndex(int device_index)
903
904
905
{
recDevice *device = gpDeviceList;
906
for (; device_index > 0; device_index--)
907
908
device = device->pNext;
909
return device->product;
910
911
}
912
913
914
915
916
917
918
/* Function to return the instance id of the joystick at device_index
*/
SDL_JoystickID
SDL_SYS_GetInstanceIdOfDeviceIndex(int device_index)
{
recDevice *device = gpDeviceList;
int index;
919
920
921
922
for (index = device_index; index > 0; index--)
device = device->pNext;
923
return device->instance_id;
924
925
}
926
927
928
929
930
931
/* Function to open a joystick for use.
* The joystick to open is specified by the index field of the joystick.
* This should fill the nbuttons and naxes fields of the joystick structure.
* It returns 0, or -1 if there is an error.
*/
int
932
SDL_SYS_JoystickOpen(SDL_Joystick * joystick, int device_index)
933
934
935
936
{
recDevice *device = gpDeviceList;
int index;
937
for (index = device_index; index > 0; index--)
938
939
device = device->pNext;
940
joystick->instance_id = device->instance_id;
941
joystick->hwdata = device;
942
joystick->name = device->product;
943
944
945
946
947
joystick->naxes = device->axes;
joystick->nhats = device->hats;
joystick->nballs = 0;
joystick->nbuttons = device->buttons;
948
949
950
return 0;
}
951
952
/* Function to query if the joystick is currently attached
* It returns 1 if attached, 0 otherwise.
953
*/
954
955
SDL_bool
SDL_SYS_JoystickAttached(SDL_Joystick * joystick)
956
{
957
958
959
960
961
962
recDevice *device = gpDeviceList;
while ( device )
{
if ( joystick->instance_id == device->instance_id )
return SDL_TRUE;
963
964
device = device->pNext;
965
966
967
}
return SDL_FALSE;
968
969
}
970
971
972
973
974
975
976
977
/* Function to update the state of a joystick - called as a device poll.
* This function shouldn't update the joystick structure directly,
* but instead should call SDL_PrivateJoystick*() to deliver events
* and update joystick device state.
*/
void
SDL_SYS_JoystickUpdate(SDL_Joystick * joystick)
{
978
recDevice *device = joystick->hwdata;
979
980
981
982
recElement *element;
SInt32 value, range;
int i;
983
984
if ( !device )
return;
985
986
if (device->removed) { /* device was unplugged; ignore it. */
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
recDevice *devicelist = gpDeviceList;
joystick->closed = 1;
joystick->uncentered = 1;
if ( devicelist == device )
{
gpDeviceList = device->pNext;
}
else
{
while ( devicelist->pNext != device )
{
devicelist = devicelist->pNext;
}