Skip to content
This repository has been archived by the owner on Feb 11, 2021. It is now read-only.

Latest commit

 

History

History
851 lines (746 loc) · 30.2 KB

SDL_sysjoystick.c

File metadata and controls

851 lines (746 loc) · 30.2 KB
 
Sep 11, 2001
Sep 11, 2001
1
2
/*
SDL - Simple DirectMedia Layer
Dec 8, 2008
Dec 8, 2008
3
Copyright (C) 1997-2009 Sam Lantinga
Sep 11, 2001
Sep 11, 2001
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Sam Lantinga
Dec 14, 2001
Dec 14, 2001
20
slouken@libsdl.org
Sep 11, 2001
Sep 11, 2001
21
*/
Feb 21, 2006
Feb 21, 2006
22
#include "SDL_config.h"
Sep 11, 2001
Sep 11, 2001
23
Apr 14, 2006
Apr 14, 2006
24
25
#ifdef SDL_JOYSTICK_IOKIT
Apr 13, 2006
Apr 13, 2006
26
/* SDL joystick driver for Darwin / Mac OS X, based on the IOKit HID API */
Sep 11, 2001
Sep 11, 2001
27
28
29
30
31
32
33
34
35
/* 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>
Oct 16, 2001
Oct 16, 2001
36
37
38
#ifdef MACOS_10_0_4
#include <IOKit/hidsystem/IOHIDUsageTables.h>
#else
Apr 13, 2006
Apr 13, 2006
39
/* The header was moved here in Mac OS X 10.1 */
Oct 16, 2001
Oct 16, 2001
40
#include <Kernel/IOKit/hidsystem/IOHIDUsageTables.h>
Oct 16, 2001
Oct 16, 2001
41
#endif
May 31, 2007
May 31, 2007
42
43
44
#if MAC_OS_X_VERSION_MIN_REQUIRED == 1030
#include "10.3.9-FIX/IOHIDLib.h"
#else
Sep 11, 2001
Sep 11, 2001
45
#include <IOKit/hid/IOHIDLib.h>
May 31, 2007
May 31, 2007
46
#endif
Sep 11, 2001
Sep 11, 2001
47
48
#include <IOKit/hid/IOHIDKeys.h>
#include <CoreFoundation/CoreFoundation.h>
Jul 10, 2006
Jul 10, 2006
49
#include <Carbon/Carbon.h> /* for NewPtrClear, DisposePtr */
Sep 11, 2001
Sep 11, 2001
50
Aug 25, 2008
Aug 25, 2008
51
52
53
54
/* For force feedback testing. */
#include <ForceFeedback/ForceFeedback.h>
#include <ForceFeedback/ForceFeedbackConstants.h>
Sep 11, 2001
Sep 11, 2001
55
#include "SDL_joystick.h"
Feb 16, 2006
Feb 16, 2006
56
57
#include "../SDL_sysjoystick.h"
#include "../SDL_joystick_c.h"
Aug 25, 2008
Aug 25, 2008
58
#include "SDL_sysjoystick_c.h"
Sep 11, 2001
Sep 11, 2001
59
60
61
62
63
64
/* Linked list of all available devices */
static recDevice *gpDeviceList = NULL;
Jul 10, 2006
Jul 10, 2006
65
66
static void
HIDReportErrorNum(char *strError, long numError)
Sep 11, 2001
Sep 11, 2001
67
{
Jul 10, 2006
Jul 10, 2006
68
SDL_SetError(strError);
Sep 11, 2001
Sep 11, 2001
69
70
}
Jul 10, 2006
Jul 10, 2006
71
72
static void HIDGetCollectionElements(CFMutableDictionaryRef deviceProperties,
recDevice * pDevice);
Sep 11, 2001
Sep 11, 2001
73
74
75
76
77
/* returns current value for element, polling element
* will return 0 on error conditions which should be accounted for by application
*/
Jul 10, 2006
Jul 10, 2006
78
79
static SInt32
HIDGetElementValue(recDevice * pDevice, recElement * pElement)
Sep 11, 2001
Sep 11, 2001
80
{
Jul 10, 2006
Jul 10, 2006
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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;
Sep 11, 2001
Sep 11, 2001
101
102
}
Jul 10, 2006
Jul 10, 2006
103
104
105
static SInt32
HIDScaledCalibratedValue(recDevice * pDevice, recElement * pElement,
long min, long max)
Sep 11, 2001
Sep 11, 2001
106
{
Jul 10, 2006
Jul 10, 2006
107
108
109
110
111
112
113
114
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;
Sep 11, 2001
Sep 11, 2001
115
116
}
Feb 26, 2004
Feb 26, 2004
117
Jul 10, 2006
Jul 10, 2006
118
119
static void
HIDRemovalCallback(void *target, IOReturn result, void *refcon, void *sender)
Feb 26, 2004
Feb 26, 2004
120
{
Jul 10, 2006
Jul 10, 2006
121
122
123
recDevice *device = (recDevice *) refcon;
device->removed = 1;
device->uncentered = 1;
Feb 26, 2004
Feb 26, 2004
124
125
126
127
}
Sep 11, 2001
Sep 11, 2001
128
129
130
131
/* Create and open an interface to device, required prior to extracting values or building queues.
* Note: appliction now owns the device and must close and release it prior to exiting
*/
Jul 10, 2006
Jul 10, 2006
132
133
static IOReturn
HIDCreateOpenDeviceInterface(io_object_t hidDevice, recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
134
{
Jul 10, 2006
Jul 10, 2006
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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),
Aug 27, 2008
Aug 27, 2008
152
153
(void *)
&(pDevice->interface));
Jul 10, 2006
Jul 10, 2006
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
if (S_OK != plugInResult)
HIDReportErrorNum
("CouldnÕt query HID class device interface from plugInInterface",
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
(*(pDevice->interface))->setRemovalCallback(pDevice->interface,
HIDRemovalCallback,
pDevice, pDevice);
}
return result;
Sep 11, 2001
Sep 11, 2001
176
177
178
179
180
181
182
183
}
/* Closes and releases interface to device, should be done prior to exting application
* 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)
*/
Jul 10, 2006
Jul 10, 2006
184
185
static IOReturn
HIDCloseReleaseInterface(recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
186
{
Jul 10, 2006
Jul 10, 2006
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
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;
}
return result;
Sep 11, 2001
Sep 11, 2001
205
206
207
208
}
/* extracts actual specific element information from each element CF dictionary entry */
Jul 10, 2006
Jul 10, 2006
209
210
static void
HIDGetElementInfo(CFTypeRef refElement, recElement * pElement)
Sep 11, 2001
Sep 11, 2001
211
{
Jul 10, 2006
Jul 10, 2006
212
213
214
215
216
217
218
219
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))
May 29, 2007
May 29, 2007
220
pElement->minReport = pElement->min = number;
Jul 10, 2006
Jul 10, 2006
221
222
223
pElement->maxReport = pElement->min;
refType = CFDictionaryGetValue(refElement, CFSTR(kIOHIDElementMaxKey));
if (refType && CFNumberGetValue(refType, kCFNumberLongType, &number))
May 29, 2007
May 29, 2007
224
pElement->maxReport = pElement->max = number;
Sep 11, 2001
Sep 11, 2001
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
/*
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);
*/
Jul 10, 2006
Jul 10, 2006
253
}
Sep 11, 2001
Sep 11, 2001
254
255
256
257
258
259
/* examines CF dictionary vlaue in device element hierarchy to determine if it is element of interest or a collection of more elements
* 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
*/
Jul 10, 2006
Jul 10, 2006
260
261
static void
HIDAddElement(CFTypeRef refElement, recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
262
{
Jul 10, 2006
Jul 10, 2006
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
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 */
Nov 8, 2008
Nov 8, 2008
334
335
336
337
338
339
340
recElement *elementPrevious = NULL;
recElement *elementCurrent = *headElement;
while (elementCurrent && usage >= elementCurrent->usage) {
elementPrevious = elementCurrent;
elementCurrent = elementCurrent->pNext;
}
if (elementPrevious) {
Jul 10, 2006
Jul 10, 2006
341
elementPrevious->pNext = element;
Nov 8, 2008
Nov 8, 2008
342
343
} else {
*headElement = element;
Jul 10, 2006
Jul 10, 2006
344
}
Nov 8, 2008
Nov 8, 2008
345
346
347
element->usagePage = usagePage;
element->usage = usage;
element->pNext = elementCurrent;
Jul 10, 2006
Jul 10, 2006
348
HIDGetElementInfo(refElement, element);
Nov 8, 2008
Nov 8, 2008
349
pDevice->elements++;
Jul 10, 2006
Jul 10, 2006
350
}
Sep 11, 2001
Sep 11, 2001
351
352
353
354
}
/* collects information from each array member in device element list (each array memeber = element) */
Jul 10, 2006
Jul 10, 2006
355
356
static void
HIDGetElementsCFArrayHandler(const void *value, void *parameter)
Sep 11, 2001
Sep 11, 2001
357
{
Jul 10, 2006
Jul 10, 2006
358
359
if (CFGetTypeID(value) == CFDictionaryGetTypeID())
HIDAddElement((CFTypeRef) value, (recDevice *) parameter);
Sep 11, 2001
Sep 11, 2001
360
361
362
363
}
/* handles retrieval of element information from arrays of elements in device IO registry information */
Jul 10, 2006
Jul 10, 2006
364
365
static void
HIDGetElements(CFTypeRef refElementCurrent, recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
366
{
Jul 10, 2006
Jul 10, 2006
367
368
369
370
371
372
373
374
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);
}
}
Sep 11, 2001
Sep 11, 2001
375
376
377
378
379
/* handles extracting element information from element collection CF types
* used from top level element decoding and hierarchy deconstruction to flatten device element list
*/
Jul 10, 2006
Jul 10, 2006
380
381
382
static void
HIDGetCollectionElements(CFMutableDictionaryRef deviceProperties,
recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
383
{
Jul 10, 2006
Jul 10, 2006
384
385
386
387
CFTypeRef refElementTop =
CFDictionaryGetValue(deviceProperties, CFSTR(kIOHIDElementKey));
if (refElementTop)
HIDGetElements(refElementTop, pDevice);
Sep 11, 2001
Sep 11, 2001
388
389
390
391
}
/* use top level element usage page and usage to discern device usage page and usage setting appropriate vlaues in device record */
Jul 10, 2006
Jul 10, 2006
392
393
static void
HIDTopLevelElementHandler(const void *value, void *parameter)
Sep 11, 2001
Sep 11, 2001
394
{
Jul 10, 2006
Jul 10, 2006
395
396
397
398
399
400
401
402
403
404
405
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.");
Sep 11, 2001
Sep 11, 2001
406
407
408
409
}
/* extracts device info from CF dictionary records in IO registry */
Jul 10, 2006
Jul 10, 2006
410
411
412
static void
HIDGetDeviceInfo(io_object_t hidDevice, CFMutableDictionaryRef hidProperties,
recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
413
{
Jul 10, 2006
Jul 10, 2006
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
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
* get dictionary for usb properties: step up two levels and get CF dictionary for USB properties
*/
if ((KERN_SUCCESS ==
IORegistryEntryGetParentEntry(hidDevice, kIOServicePlane, &parent1))
&& (KERN_SUCCESS ==
IORegistryEntryGetParentEntry(parent1, kIOServicePlane, &parent2))
&& (KERN_SUCCESS ==
IORegistryEntryCreateCFProperties(parent2, &usbProperties,
kCFAllocatorDefault,
kNilOptions))) {
if (usbProperties) {
CFTypeRef refCF = 0;
/* get device info
* try hid dictionary first, if fail then go to usb dictionary
*/
/* get product name */
refCF =
CFDictionaryGetValue(hidProperties, CFSTR(kIOHIDProductKey));
if (!refCF)
refCF =
CFDictionaryGetValue(usbProperties,
CFSTR("USB Product Name"));
if (refCF) {
if (!CFStringGetCString
(refCF, pDevice->product, 256,
CFStringGetSystemEncoding()))
SDL_SetError
("CFStringGetCString error retrieving pDevice->product.");
}
/* get usage page and usage */
refCF =
CFDictionaryGetValue(hidProperties,
CFSTR(kIOHIDPrimaryUsagePageKey));
if (refCF) {
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.");
}
if (NULL == refCF) { /* get top level element HID usage page or usage */
/* use top level element instead */
CFTypeRef refCFTopElement = 0;
refCFTopElement =
CFDictionaryGetValue(hidProperties,
CFSTR(kIOHIDElementKey));
{
/* refCFTopElement points to an array of element dictionaries */
CFRange range = { 0, CFArrayGetCount(refCFTopElement) };
CFArrayApplyFunction(refCFTopElement, range,
HIDTopLevelElementHandler, pDevice);
}
}
CFRelease(usbProperties);
} else
SDL_SetError
("IORegistryEntryCreateCFProperties failed to create usbProperties.");
if (kIOReturnSuccess != IOObjectRelease(parent2))
SDL_SetError("IOObjectRelease error with parent2.");
if (kIOReturnSuccess != IOObjectRelease(parent1))
SDL_SetError("IOObjectRelease error with parent1.");
}
Sep 11, 2001
Sep 11, 2001
493
494
495
}
Jul 10, 2006
Jul 10, 2006
496
497
static recDevice *
HIDBuildDevice(io_object_t hidDevice)
Sep 11, 2001
Sep 11, 2001
498
{
Jul 10, 2006
Jul 10, 2006
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
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);
} else {
DisposePtr((Ptr) pDevice);
pDevice = NULL;
}
CFRelease(hidProperties);
} else {
DisposePtr((Ptr) pDevice);
pDevice = NULL;
}
}
return pDevice;
Sep 11, 2001
Sep 11, 2001
524
525
526
527
528
}
/* disposes of the element list associated with a device and the memory associated with the list
*/
Jul 10, 2006
Jul 10, 2006
529
530
static void
HIDDisposeElementList(recElement ** elementList)
Sep 11, 2001
Sep 11, 2001
531
{
Jul 10, 2006
Jul 10, 2006
532
533
534
535
536
537
538
recElement *pElement = *elementList;
while (pElement) {
recElement *pElementNext = pElement->pNext;
DisposePtr((Ptr) pElement);
pElement = pElementNext;
}
*elementList = NULL;
Sep 11, 2001
Sep 11, 2001
539
540
541
542
543
544
}
/* 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)
*/
Jul 10, 2006
Jul 10, 2006
545
546
static recDevice *
HIDDisposeDevice(recDevice ** ppDevice)
Sep 11, 2001
Sep 11, 2001
547
{
Jul 10, 2006
Jul 10, 2006
548
549
550
551
552
553
kern_return_t result = KERN_SUCCESS;
recDevice *pDeviceNext = NULL;
if (*ppDevice) {
/* save next device prior to disposing of this device */
pDeviceNext = (*ppDevice)->pNext;
Aug 25, 2008
Aug 25, 2008
554
555
556
557
558
559
/* free posible io_service_t */
if ((*ppDevice)->ffservice) {
IOObjectRelease((*ppDevice)->ffservice);
(*ppDevice)->ffservice = 0;
}
Jul 10, 2006
Jul 10, 2006
560
561
562
563
564
565
566
567
568
569
570
571
572
573
/* 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;
Sep 11, 2001
Sep 11, 2001
574
575
576
577
578
579
580
581
}
/* 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.
*/
Jul 10, 2006
Jul 10, 2006
582
583
int
SDL_SYS_JoystickInit(void)
Sep 11, 2001
Sep 11, 2001
584
{
Jul 10, 2006
Jul 10, 2006
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
IOReturn result = kIOReturnSuccess;
mach_port_t masterPort = 0;
io_iterator_t hidObjectIterator = 0;
CFMutableDictionaryRef hidMatchDictionary = NULL;
recDevice *device, *lastDevice;
io_object_t ioHIDDeviceObject = 0;
SDL_numjoysticks = 0;
if (gpDeviceList) {
SDL_SetError("Joystick: Device list already inited.");
return -1;
}
result = IOMasterPort(bootstrap_port, &masterPort);
if (kIOReturnSuccess != result) {
SDL_SetError("Joystick: IOMasterPort error with bootstrap_port.");
return -1;
}
/* 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 {
SDL_SetError
("Joystick: Failed to get HID CFMutableDictionaryRef via IOServiceMatching.");
return -1;
}
/*/ Now search I/O Registry for matching devices. */
result =
IOServiceGetMatchingServices(masterPort, hidMatchDictionary,
&hidObjectIterator);
/* Check for errors */
if (kIOReturnSuccess != result) {
SDL_SetError("Joystick: Couldn't create a HID object iterator.");
return -1;
}
if (!hidObjectIterator) { /* there are no joysticks */
gpDeviceList = NULL;
SDL_numjoysticks = 0;
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 */
gpDeviceList = lastDevice = NULL;
while ((ioHIDDeviceObject = IOIteratorNext(hidObjectIterator))) {
/* build a device record */
device = HIDBuildDevice(ioHIDDeviceObject);
if (!device)
continue;
/* Filter device list to non-keyboard/mouse stuff */
Jun 14, 2007
Jun 14, 2007
653
654
655
656
if ((device->usagePage != kHIDPage_GenericDesktop) ||
((device->usage != kHIDUsage_GD_Joystick &&
device->usage != kHIDUsage_GD_GamePad &&
device->usage != kHIDUsage_GD_MultiAxisController))) {
Jul 10, 2006
Jul 10, 2006
657
658
659
660
661
662
663
/* release memory for the device */
HIDDisposeDevice(&device);
DisposePtr((Ptr) device);
continue;
}
Aug 25, 2008
Aug 25, 2008
664
665
666
667
668
669
670
671
/* 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;
}
Jul 10, 2006
Jul 10, 2006
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
/* Add device to the end of the list */
if (lastDevice)
lastDevice->pNext = device;
else
gpDeviceList = device;
lastDevice = device;
}
result = IOObjectRelease(hidObjectIterator); /* release the iterator */
/* Count the total number of devices we found */
device = gpDeviceList;
while (device) {
SDL_numjoysticks++;
device = device->pNext;
}
return SDL_numjoysticks;
Sep 11, 2001
Sep 11, 2001
689
690
691
}
/* Function to get the device-dependent name of a joystick */
Jul 10, 2006
Jul 10, 2006
692
693
const char *
SDL_SYS_JoystickName(int index)
Sep 11, 2001
Sep 11, 2001
694
{
Jul 10, 2006
Jul 10, 2006
695
recDevice *device = gpDeviceList;
Sep 11, 2001
Sep 11, 2001
696
Jul 10, 2006
Jul 10, 2006
697
698
699
700
for (; index > 0; index--)
device = device->pNext;
return device->product;
Sep 11, 2001
Sep 11, 2001
701
702
703
704
705
706
707
}
/* 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.
*/
Jul 10, 2006
Jul 10, 2006
708
709
int
SDL_SYS_JoystickOpen(SDL_Joystick * joystick)
Sep 11, 2001
Sep 11, 2001
710
{
Jul 10, 2006
Jul 10, 2006
711
712
713
714
715
recDevice *device = gpDeviceList;
int index;
for (index = joystick->index; index > 0; index--)
device = device->pNext;
Sep 11, 2001
Sep 11, 2001
716
Jul 10, 2006
Jul 10, 2006
717
718
joystick->hwdata = device;
joystick->name = device->product;
Sep 11, 2001
Sep 11, 2001
719
Jul 10, 2006
Jul 10, 2006
720
721
722
723
joystick->naxes = device->axes;
joystick->nhats = device->hats;
joystick->nballs = 0;
joystick->nbuttons = device->buttons;
Sep 11, 2001
Sep 11, 2001
724
Jul 10, 2006
Jul 10, 2006
725
return 0;
Sep 11, 2001
Sep 11, 2001
726
727
728
729
730
731
732
}
/* 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.
*/
Jul 10, 2006
Jul 10, 2006
733
734
void
SDL_SYS_JoystickUpdate(SDL_Joystick * joystick)
Sep 11, 2001
Sep 11, 2001
735
{
Jul 10, 2006
Jul 10, 2006
736
737
recDevice *device = joystick->hwdata;
recElement *element;
Dec 29, 2007
Dec 29, 2007
738
SInt32 value, range;
Jul 10, 2006
Jul 10, 2006
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
int i;
if (device->removed) { /* device was unplugged; ignore it. */
if (device->uncentered) {
device->uncentered = 0;
/* Tell the app that everything is centered/unpressed... */
for (i = 0; i < device->axes; i++)
SDL_PrivateJoystickAxis(joystick, i, 0);
for (i = 0; i < device->buttons; i++)
SDL_PrivateJoystickButton(joystick, i, 0);
for (i = 0; i < device->hats; i++)
SDL_PrivateJoystickHat(joystick, i, SDL_HAT_CENTERED);
}
return;
}
element = device->firstAxis;
i = 0;
while (element) {
value = HIDScaledCalibratedValue(device, element, -32768, 32767);
if (value != joystick->axes[i])
SDL_PrivateJoystickAxis(joystick, i, value);
element = element->pNext;
++i;
}
element = device->firstButton;
i = 0;
while (element) {
value = HIDGetElementValue(device, element);
if (value > 1) /* handle pressure-sensitive buttons */
May 29, 2003
May 29, 2003
774
value = 1;
Jul 10, 2006
Jul 10, 2006
775
776
777
778
779
780
781
782
783
784
785
if (value != joystick->buttons[i])
SDL_PrivateJoystickButton(joystick, i, value);
element = element->pNext;
++i;
}
element = device->firstHat;
i = 0;
while (element) {
Uint8 pos = 0;
Dec 29, 2007
Dec 29, 2007
786
787
range = (element->max - element->min + 1);
value = HIDGetElementValue(device, element) - element->min;
Jan 8, 2008
Jan 8, 2008
788
if (range == 4) /* 4 position hatswitch - scale up value */
Jul 10, 2006
Jul 10, 2006
789
value *= 2;
Jan 8, 2008
Jan 8, 2008
790
else if (range != 8) /* Neither a 4 nor 8 positions - fall back to default position (centered) */
Jul 10, 2006
Jul 10, 2006
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
value = -1;
switch (value) {
case 0:
pos = SDL_HAT_UP;
break;
case 1:
pos = SDL_HAT_RIGHTUP;
break;
case 2:
pos = SDL_HAT_RIGHT;
break;
case 3:
pos = SDL_HAT_RIGHTDOWN;
break;
case 4:
pos = SDL_HAT_DOWN;
break;
case 5:
pos = SDL_HAT_LEFTDOWN;
break;
case 6:
pos = SDL_HAT_LEFT;
break;
case 7:
pos = SDL_HAT_LEFTUP;
break;
default:
/* Every other value is mapped to center. We do that because some
* joysticks use 8 and some 15 for this value, and apparently
* there are even more variants out there - so we try to be generous.
*/
pos = SDL_HAT_CENTERED;
break;
}
if (pos != joystick->hats[i])
SDL_PrivateJoystickHat(joystick, i, pos);
element = element->pNext;
++i;
}
return;
Sep 11, 2001
Sep 11, 2001
832
833
834
}
/* Function to close a joystick after use */
Jul 10, 2006
Jul 10, 2006
835
836
void
SDL_SYS_JoystickClose(SDL_Joystick * joystick)
Sep 11, 2001
Sep 11, 2001
837
{
Jul 10, 2006
Jul 10, 2006
838
839
/* Should we do anything here? */
return;
Sep 11, 2001
Sep 11, 2001
840
841
842
}
/* Function to perform any system-specific joystick related cleanup */
Jul 10, 2006
Jul 10, 2006
843
844
void
SDL_SYS_JoystickQuit(void)
Sep 11, 2001
Sep 11, 2001
845
{
Jul 10, 2006
Jul 10, 2006
846
847
while (NULL != gpDeviceList)
gpDeviceList = HIDDisposeDevice(&gpDeviceList);
Sep 11, 2001
Sep 11, 2001
848
}
Apr 14, 2006
Apr 14, 2006
849
850
#endif /* SDL_JOYSTICK_IOKIT */
Jul 10, 2006
Jul 10, 2006
851
/* vi: set ts=4 sw=4 expandtab: */