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

Latest commit

 

History

History
885 lines (772 loc) · 31.9 KB

SDL_sysjoystick.c

File metadata and controls

885 lines (772 loc) · 31.9 KB
 
Sep 11, 2001
Sep 11, 2001
1
2
/*
SDL - Simple DirectMedia Layer
Jan 4, 2004
Jan 4, 2004
3
Copyright (C) 1997-2004 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
51
#include "SDL_joystick.h"
Feb 16, 2006
Feb 16, 2006
52
53
#include "../SDL_sysjoystick.h"
#include "../SDL_joystick_c.h"
Sep 11, 2001
Sep 11, 2001
54
55
56
struct recElement
{
Jul 10, 2006
Jul 10, 2006
57
58
59
IOHIDElementCookie cookie; /* unique value which identifies element, will NOT change */
long min; /* reported min value possible */
long max; /* reported max value possible */
Mar 9, 2006
Mar 9, 2006
60
#if 0
Jul 10, 2006
Jul 10, 2006
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/* TODO: maybe should handle the following stuff somehow? */
long scaledMin; /* reported scaled min value possible */
long scaledMax; /* reported scaled max value possible */
long size; /* size in bits of data return from element */
Boolean relative; /* are reports relative to last report (deltas) */
Boolean wrapping; /* does element wrap around (one value higher than max is min) */
Boolean nonLinear; /* are the values reported non-linear relative to element movement */
Boolean preferredState; /* does element have a preferred state (such as a button) */
Boolean nullState; /* does element have null state */
#endif /* 0 */
/* runtime variables used for auto-calibration */
long minReport; /* min returned value */
long maxReport; /* max returned value */
struct recElement *pNext; /* next element in list */
Sep 11, 2001
Sep 11, 2001
78
79
80
81
82
};
typedef struct recElement recElement;
struct joystick_hwdata
{
Jul 10, 2006
Jul 10, 2006
83
IOHIDDeviceInterface **interface; /* interface to device, NULL = no interface */
Sep 11, 2001
Sep 11, 2001
84
Jul 10, 2006
Jul 10, 2006
85
86
87
char product[256]; /* name of product */
long usage; /* usage page from IOUSBHID Parser.h which defines general usage */
long usagePage; /* usage within above page from IOUSBHID Parser.h which defines specific usage */
Sep 11, 2001
Sep 11, 2001
88
Jul 10, 2006
Jul 10, 2006
89
90
91
92
long axes; /* number of axis (calculated, not reported by device) */
long buttons; /* number of buttons (calculated, not reported by device) */
long hats; /* number of hat switches (calculated, not reported by device) */
long elements; /* number of total elements (shouldbe total of above) (calculated, not reported by device) */
Sep 11, 2001
Sep 11, 2001
93
Jul 10, 2006
Jul 10, 2006
94
95
96
recElement *firstAxis;
recElement *firstButton;
recElement *firstHat;
Sep 11, 2001
Sep 11, 2001
97
Jul 10, 2006
Jul 10, 2006
98
99
int removed;
int uncentered;
Feb 26, 2004
Feb 26, 2004
100
Jul 10, 2006
Jul 10, 2006
101
struct joystick_hwdata *pNext; /* next device */
Sep 11, 2001
Sep 11, 2001
102
103
104
105
106
107
108
109
};
typedef struct joystick_hwdata recDevice;
/* Linked list of all available devices */
static recDevice *gpDeviceList = NULL;
Jul 10, 2006
Jul 10, 2006
110
111
static void
HIDReportErrorNum(char *strError, long numError)
Sep 11, 2001
Sep 11, 2001
112
{
Jul 10, 2006
Jul 10, 2006
113
SDL_SetError(strError);
Sep 11, 2001
Sep 11, 2001
114
115
}
Jul 10, 2006
Jul 10, 2006
116
117
static void HIDGetCollectionElements(CFMutableDictionaryRef deviceProperties,
recDevice * pDevice);
Sep 11, 2001
Sep 11, 2001
118
119
120
121
122
/* 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
123
124
static SInt32
HIDGetElementValue(recDevice * pDevice, recElement * pElement)
Sep 11, 2001
Sep 11, 2001
125
{
Jul 10, 2006
Jul 10, 2006
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
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
146
147
}
Jul 10, 2006
Jul 10, 2006
148
149
150
static SInt32
HIDScaledCalibratedValue(recDevice * pDevice, recElement * pElement,
long min, long max)
Sep 11, 2001
Sep 11, 2001
151
{
Jul 10, 2006
Jul 10, 2006
152
153
154
155
156
157
158
159
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
160
161
}
Feb 26, 2004
Feb 26, 2004
162
Jul 10, 2006
Jul 10, 2006
163
164
static void
HIDRemovalCallback(void *target, IOReturn result, void *refcon, void *sender)
Feb 26, 2004
Feb 26, 2004
165
{
Jul 10, 2006
Jul 10, 2006
166
167
168
recDevice *device = (recDevice *) refcon;
device->removed = 1;
device->uncentered = 1;
Feb 26, 2004
Feb 26, 2004
169
170
171
172
}
Sep 11, 2001
Sep 11, 2001
173
174
175
176
/* 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
177
178
static IOReturn
HIDCreateOpenDeviceInterface(io_object_t hidDevice, recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
179
{
Jul 10, 2006
Jul 10, 2006
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
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
("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
221
222
223
224
225
226
227
228
}
/* 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
229
230
static IOReturn
HIDCloseReleaseInterface(recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
231
{
Jul 10, 2006
Jul 10, 2006
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
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
250
251
252
253
}
/* extracts actual specific element information from each element CF dictionary entry */
Jul 10, 2006
Jul 10, 2006
254
255
static void
HIDGetElementInfo(CFTypeRef refElement, recElement * pElement)
Sep 11, 2001
Sep 11, 2001
256
{
Jul 10, 2006
Jul 10, 2006
257
258
259
260
261
262
263
264
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
265
pElement->minReport = pElement->min = number;
Jul 10, 2006
Jul 10, 2006
266
267
268
pElement->maxReport = pElement->min;
refType = CFDictionaryGetValue(refElement, CFSTR(kIOHIDElementMaxKey));
if (refType && CFNumberGetValue(refType, kCFNumberLongType, &number))
May 29, 2007
May 29, 2007
269
pElement->maxReport = pElement->max = number;
Sep 11, 2001
Sep 11, 2001
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
/*
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
298
}
Sep 11, 2001
Sep 11, 2001
299
300
301
302
303
304
/* 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
305
306
static void
HIDAddElement(CFTypeRef refElement, recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
307
{
Jul 10, 2006
Jul 10, 2006
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
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 */
pDevice->elements++;
if (NULL == *headElement)
*headElement = element;
else {
recElement *elementPrevious, *elementCurrent;
elementCurrent = *headElement;
while (elementCurrent) {
elementPrevious = elementCurrent;
elementCurrent = elementPrevious->pNext;
}
elementPrevious->pNext = element;
}
element->pNext = NULL;
HIDGetElementInfo(refElement, element);
}
Sep 11, 2001
Sep 11, 2001
394
395
396
397
}
/* collects information from each array member in device element list (each array memeber = element) */
Jul 10, 2006
Jul 10, 2006
398
399
static void
HIDGetElementsCFArrayHandler(const void *value, void *parameter)
Sep 11, 2001
Sep 11, 2001
400
{
Jul 10, 2006
Jul 10, 2006
401
402
if (CFGetTypeID(value) == CFDictionaryGetTypeID())
HIDAddElement((CFTypeRef) value, (recDevice *) parameter);
Sep 11, 2001
Sep 11, 2001
403
404
405
406
}
/* handles retrieval of element information from arrays of elements in device IO registry information */
Jul 10, 2006
Jul 10, 2006
407
408
static void
HIDGetElements(CFTypeRef refElementCurrent, recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
409
{
Jul 10, 2006
Jul 10, 2006
410
411
412
413
414
415
416
417
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
418
419
420
421
422
/* 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
423
424
425
static void
HIDGetCollectionElements(CFMutableDictionaryRef deviceProperties,
recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
426
{
Jul 10, 2006
Jul 10, 2006
427
428
429
430
CFTypeRef refElementTop =
CFDictionaryGetValue(deviceProperties, CFSTR(kIOHIDElementKey));
if (refElementTop)
HIDGetElements(refElementTop, pDevice);
Sep 11, 2001
Sep 11, 2001
431
432
433
434
}
/* 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
435
436
static void
HIDTopLevelElementHandler(const void *value, void *parameter)
Sep 11, 2001
Sep 11, 2001
437
{
Jul 10, 2006
Jul 10, 2006
438
439
440
441
442
443
444
445
446
447
448
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
449
450
451
452
}
/* extracts device info from CF dictionary records in IO registry */
Jul 10, 2006
Jul 10, 2006
453
454
455
static void
HIDGetDeviceInfo(io_object_t hidDevice, CFMutableDictionaryRef hidProperties,
recDevice * pDevice)
Sep 11, 2001
Sep 11, 2001
456
{
Jul 10, 2006
Jul 10, 2006
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
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
536
537
538
}
Jul 10, 2006
Jul 10, 2006
539
540
static recDevice *
HIDBuildDevice(io_object_t hidDevice)
Sep 11, 2001
Sep 11, 2001
541
{
Jul 10, 2006
Jul 10, 2006
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
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
567
568
569
570
571
}
/* disposes of the element list associated with a device and the memory associated with the list
*/
Jul 10, 2006
Jul 10, 2006
572
573
static void
HIDDisposeElementList(recElement ** elementList)
Sep 11, 2001
Sep 11, 2001
574
{
Jul 10, 2006
Jul 10, 2006
575
576
577
578
579
580
581
recElement *pElement = *elementList;
while (pElement) {
recElement *pElementNext = pElement->pNext;
DisposePtr((Ptr) pElement);
pElement = pElementNext;
}
*elementList = NULL;
Sep 11, 2001
Sep 11, 2001
582
583
584
585
586
587
}
/* 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
588
589
static recDevice *
HIDDisposeDevice(recDevice ** ppDevice)
Sep 11, 2001
Sep 11, 2001
590
{
Jul 10, 2006
Jul 10, 2006
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
kern_return_t result = KERN_SUCCESS;
recDevice *pDeviceNext = NULL;
if (*ppDevice) {
/* save next device prior to disposing of this device */
pDeviceNext = (*ppDevice)->pNext;
/* 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
611
612
613
614
615
616
617
618
}
/* 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
619
620
int
SDL_SYS_JoystickInit(void)
Sep 11, 2001
Sep 11, 2001
621
{
Jul 10, 2006
Jul 10, 2006
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
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;
/* dump device object, it is no longer needed */
result = IOObjectRelease(ioHIDDeviceObject);
Mar 9, 2006
Mar 9, 2006
691
692
693
/* if (KERN_SUCCESS != result)
HIDReportErrorNum ("IOObjectRelease error with ioHIDDeviceObject.", result);
*/
Sep 16, 2002
Sep 16, 2002
694
Jul 10, 2006
Jul 10, 2006
695
/* Filter device list to non-keyboard/mouse stuff */
Jun 14, 2007
Jun 14, 2007
696
697
698
699
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
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
/* release memory for the device */
HIDDisposeDevice(&device);
DisposePtr((Ptr) device);
continue;
}
/* 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
724
725
726
}
/* Function to get the device-dependent name of a joystick */
Jul 10, 2006
Jul 10, 2006
727
728
const char *
SDL_SYS_JoystickName(int index)
Sep 11, 2001
Sep 11, 2001
729
{
Jul 10, 2006
Jul 10, 2006
730
recDevice *device = gpDeviceList;
Sep 11, 2001
Sep 11, 2001
731
Jul 10, 2006
Jul 10, 2006
732
733
734
735
for (; index > 0; index--)
device = device->pNext;
return device->product;
Sep 11, 2001
Sep 11, 2001
736
737
738
739
740
741
742
}
/* 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
743
744
int
SDL_SYS_JoystickOpen(SDL_Joystick * joystick)
Sep 11, 2001
Sep 11, 2001
745
{
Jul 10, 2006
Jul 10, 2006
746
747
748
749
750
recDevice *device = gpDeviceList;
int index;
for (index = joystick->index; index > 0; index--)
device = device->pNext;
Sep 11, 2001
Sep 11, 2001
751
Jul 10, 2006
Jul 10, 2006
752
753
joystick->hwdata = device;
joystick->name = device->product;
Sep 11, 2001
Sep 11, 2001
754
Jul 10, 2006
Jul 10, 2006
755
756
757
758
joystick->naxes = device->axes;
joystick->nhats = device->hats;
joystick->nballs = 0;
joystick->nbuttons = device->buttons;
Sep 11, 2001
Sep 11, 2001
759
Jul 10, 2006
Jul 10, 2006
760
return 0;
Sep 11, 2001
Sep 11, 2001
761
762
763
764
765
766
767
}
/* 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
768
769
void
SDL_SYS_JoystickUpdate(SDL_Joystick * joystick)
Sep 11, 2001
Sep 11, 2001
770
{
Jul 10, 2006
Jul 10, 2006
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
recDevice *device = joystick->hwdata;
recElement *element;
SInt32 value;
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
809
value = 1;
Jul 10, 2006
Jul 10, 2006
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
if (value != joystick->buttons[i])
SDL_PrivateJoystickButton(joystick, i, value);
element = element->pNext;
++i;
}
element = device->firstHat;
i = 0;
while (element) {
Uint8 pos = 0;
value = HIDGetElementValue(device, element);
if (element->max == 3) /* 4 position hatswitch - scale up value */
value *= 2;
else if (element->max != 7) /* Neither a 4 nor 8 positions - fall back to default position (centered) */
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
866
867
868
}
/* Function to close a joystick after use */
Jul 10, 2006
Jul 10, 2006
869
870
void
SDL_SYS_JoystickClose(SDL_Joystick * joystick)
Sep 11, 2001
Sep 11, 2001
871
{
Jul 10, 2006
Jul 10, 2006
872
873
/* Should we do anything here? */
return;
Sep 11, 2001
Sep 11, 2001
874
875
876
}
/* Function to perform any system-specific joystick related cleanup */
Jul 10, 2006
Jul 10, 2006
877
878
void
SDL_SYS_JoystickQuit(void)
Sep 11, 2001
Sep 11, 2001
879
{
Jul 10, 2006
Jul 10, 2006
880
881
while (NULL != gpDeviceList)
gpDeviceList = HIDDisposeDevice(&gpDeviceList);
Sep 11, 2001
Sep 11, 2001
882
}
Apr 14, 2006
Apr 14, 2006
883
884
#endif /* SDL_JOYSTICK_IOKIT */
Jul 10, 2006
Jul 10, 2006
885
/* vi: set ts=4 sw=4 expandtab: */