src/joystick/darwin/SDL_sysjoystick.c
author Sam Lantinga <slouken@libsdl.org>
Fri, 14 Apr 2006 04:46:47 +0000
changeset 1635 92947e3a18db
parent 1621 f12379c41042
child 1662 782fd950bd46
child 1895 c121d94672cb
child 3924 7156c3b5536b
permissions -rw-r--r--
Make sure code is only compiled if the appropriate subsystem is enabled
slouken@172
     1
/*
slouken@172
     2
	SDL - Simple DirectMedia Layer
slouken@769
     3
    Copyright (C) 1997-2004 Sam Lantinga
slouken@172
     4
slouken@172
     5
	This library is free software; you can redistribute it and/or
slouken@172
     6
	modify it under the terms of the GNU Library General Public
slouken@172
     7
	License as published by the Free Software Foundation; either
slouken@172
     8
	version 2 of the License, or (at your option) any later version.
slouken@172
     9
slouken@172
    10
	This library is distributed in the hope that it will be useful,
slouken@172
    11
	but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@172
    12
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@172
    13
	Library General Public License for more details.
slouken@172
    14
slouken@172
    15
	You should have received a copy of the GNU Library General Public
slouken@172
    16
	License along with this library; if not, write to the Free
slouken@172
    17
	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
slouken@172
    18
slouken@172
    19
	Sam Lantinga
slouken@252
    20
	slouken@libsdl.org
slouken@172
    21
*/
slouken@1402
    22
#include "SDL_config.h"
slouken@172
    23
slouken@1635
    24
#ifdef SDL_JOYSTICK_IOKIT
slouken@1635
    25
slouken@1621
    26
/* SDL joystick driver for Darwin / Mac OS X, based on the IOKit HID API */
slouken@172
    27
/* Written 2001 by Max Horn */
slouken@172
    28
slouken@172
    29
#include <unistd.h>
slouken@172
    30
#include <ctype.h>
slouken@172
    31
#include <sysexits.h>
slouken@172
    32
#include <mach/mach.h>
slouken@172
    33
#include <mach/mach_error.h>
slouken@172
    34
#include <IOKit/IOKitLib.h>
slouken@172
    35
#include <IOKit/IOCFPlugIn.h>
slouken@209
    36
#ifdef MACOS_10_0_4
slouken@209
    37
#include <IOKit/hidsystem/IOHIDUsageTables.h>
slouken@209
    38
#else
slouken@1621
    39
/* The header was moved here in Mac OS X 10.1 */
slouken@208
    40
#include <Kernel/IOKit/hidsystem/IOHIDUsageTables.h>
slouken@209
    41
#endif
slouken@172
    42
#include <IOKit/hid/IOHIDLib.h>
slouken@172
    43
#include <IOKit/hid/IOHIDKeys.h>
slouken@172
    44
#include <CoreFoundation/CoreFoundation.h>
slouken@475
    45
#include <Carbon/Carbon.h> /* for NewPtrClear, DisposePtr */
slouken@172
    46
slouken@172
    47
#include "SDL_joystick.h"
slouken@1361
    48
#include "../SDL_sysjoystick.h"
slouken@1361
    49
#include "../SDL_joystick_c.h"
slouken@172
    50
slouken@172
    51
struct recElement
slouken@172
    52
{
slouken@1487
    53
	IOHIDElementCookie cookie;				/* unique value which identifies element, will NOT change */
slouken@1487
    54
	long min;								/* reported min value possible */
slouken@1487
    55
	long max;								/* reported max value possible */
slouken@1487
    56
#if 0
slouken@1487
    57
	/* TODO: maybe should handle the following stuff somehow? */
slouken@172
    58
slouken@1487
    59
	long scaledMin;							/* reported scaled min value possible */
slouken@1487
    60
	long scaledMax;							/* reported scaled max value possible */
slouken@1487
    61
	long size;								/* size in bits of data return from element */
slouken@1487
    62
	Boolean relative;						/* are reports relative to last report (deltas) */
slouken@1487
    63
	Boolean wrapping;						/* does element wrap around (one value higher than max is min) */
slouken@1487
    64
	Boolean nonLinear;						/* are the values reported non-linear relative to element movement */
slouken@1487
    65
	Boolean preferredState;					/* does element have a preferred state (such as a button) */
slouken@1487
    66
	Boolean nullState;						/* does element have null state */
slouken@1487
    67
#endif /* 0 */
slouken@172
    68
slouken@172
    69
	/* runtime variables used for auto-calibration */
slouken@1487
    70
	long minReport;							/* min returned value */
slouken@1487
    71
	long maxReport;							/* max returned value */
slouken@172
    72
	
slouken@1487
    73
	struct recElement * pNext;				/* next element in list */
slouken@172
    74
};
slouken@172
    75
typedef struct recElement recElement;
slouken@172
    76
slouken@172
    77
struct joystick_hwdata
slouken@172
    78
{
slouken@1487
    79
	IOHIDDeviceInterface ** interface;		/* interface to device, NULL = no interface */
slouken@172
    80
slouken@1487
    81
	char product[256];							/* name of product */
slouken@1487
    82
	long usage;								/* usage page from IOUSBHID Parser.h which defines general usage */
slouken@1487
    83
	long usagePage;							/* usage within above page from IOUSBHID Parser.h which defines specific usage */
slouken@172
    84
slouken@1487
    85
	long axes;								/* number of axis (calculated, not reported by device) */
slouken@1487
    86
	long buttons;							/* number of buttons (calculated, not reported by device) */
slouken@1487
    87
	long hats;								/* number of hat switches (calculated, not reported by device) */
slouken@1487
    88
	long elements;							/* number of total elements (shouldbe total of above) (calculated, not reported by device) */
slouken@172
    89
slouken@172
    90
	recElement* firstAxis;
slouken@172
    91
	recElement* firstButton;
slouken@172
    92
	recElement* firstHat;
slouken@172
    93
slouken@858
    94
	int removed;
slouken@858
    95
	int uncentered;
slouken@858
    96
slouken@1487
    97
	struct joystick_hwdata* pNext;			/* next device */
slouken@172
    98
};
slouken@172
    99
typedef struct joystick_hwdata recDevice;
slouken@172
   100
slouken@172
   101
slouken@172
   102
/* Linked list of all available devices */
slouken@172
   103
static recDevice *gpDeviceList = NULL;
slouken@172
   104
slouken@172
   105
icculus@1077
   106
static void HIDReportErrorNum (char * strError, long numError)
slouken@172
   107
{
slouken@172
   108
	SDL_SetError(strError);
slouken@172
   109
}
slouken@172
   110
slouken@172
   111
static void HIDGetCollectionElements (CFMutableDictionaryRef deviceProperties, recDevice *pDevice);
slouken@172
   112
slouken@172
   113
/* returns current value for element, polling element
slouken@172
   114
 * will return 0 on error conditions which should be accounted for by application
slouken@172
   115
 */
slouken@172
   116
icculus@1077
   117
static SInt32 HIDGetElementValue (recDevice *pDevice, recElement *pElement)
slouken@172
   118
{
slouken@172
   119
	IOReturn result = kIOReturnSuccess;
slouken@172
   120
	IOHIDEventStruct hidEvent;
slouken@172
   121
	hidEvent.value = 0;
slouken@172
   122
	
slouken@172
   123
	if (NULL != pDevice && NULL != pElement && NULL != pDevice->interface)
slouken@172
   124
	{
slouken@172
   125
		result = (*(pDevice->interface))->getElementValue(pDevice->interface, pElement->cookie, &hidEvent);
slouken@172
   126
		if (kIOReturnSuccess == result)
slouken@172
   127
		{
slouken@172
   128
			/* record min and max for auto calibration */
slouken@172
   129
			if (hidEvent.value < pElement->minReport)
slouken@172
   130
				pElement->minReport = hidEvent.value;
slouken@172
   131
			if (hidEvent.value > pElement->maxReport)
slouken@172
   132
				pElement->maxReport = hidEvent.value;
slouken@172
   133
		}
slouken@172
   134
	}
slouken@172
   135
slouken@1487
   136
	/* auto user scale */
slouken@172
   137
	return hidEvent.value;
slouken@172
   138
}
slouken@172
   139
icculus@1077
   140
static SInt32 HIDScaledCalibratedValue (recDevice *pDevice, recElement *pElement, long min, long max)
slouken@172
   141
{
slouken@172
   142
	float deviceScale = max - min;
slouken@172
   143
	float readScale = pElement->maxReport - pElement->minReport;
slouken@172
   144
	SInt32 value = HIDGetElementValue(pDevice, pElement);
slouken@172
   145
	if (readScale == 0)
slouken@1487
   146
		return value; /* no scaling at all */
slouken@172
   147
	else
slouken@172
   148
		return ((value - pElement->minReport) * deviceScale / readScale) + min;
slouken@172
   149
}
slouken@172
   150
slouken@858
   151
slouken@858
   152
static void HIDRemovalCallback(void * target,
slouken@858
   153
                               IOReturn result,
slouken@858
   154
                               void * refcon,
slouken@858
   155
                               void * sender)
slouken@858
   156
{
slouken@858
   157
	recDevice *device = (recDevice *) refcon;
slouken@858
   158
	device->removed = 1;
slouken@858
   159
	device->uncentered = 1;
slouken@858
   160
}
slouken@858
   161
slouken@858
   162
slouken@858
   163
slouken@172
   164
/* Create and open an interface to device, required prior to extracting values or building queues.
slouken@172
   165
 * Note: appliction now owns the device and must close and release it prior to exiting
slouken@172
   166
 */
slouken@172
   167
icculus@1077
   168
static IOReturn HIDCreateOpenDeviceInterface (io_object_t hidDevice, recDevice *pDevice)
slouken@172
   169
{
slouken@172
   170
	IOReturn result = kIOReturnSuccess;
slouken@172
   171
	HRESULT plugInResult = S_OK;
slouken@172
   172
	SInt32 score = 0;
slouken@172
   173
	IOCFPlugInInterface ** ppPlugInInterface = NULL;
slouken@172
   174
	
slouken@172
   175
	if (NULL == pDevice->interface)
slouken@172
   176
	{
slouken@172
   177
		result = IOCreatePlugInInterfaceForService (hidDevice, kIOHIDDeviceUserClientTypeID,
slouken@172
   178
													kIOCFPlugInInterfaceID, &ppPlugInInterface, &score);
slouken@172
   179
		if (kIOReturnSuccess == result)
slouken@172
   180
		{
slouken@1487
   181
			/* Call a method of the intermediate plug-in to create the device interface */
slouken@172
   182
			plugInResult = (*ppPlugInInterface)->QueryInterface (ppPlugInInterface,
slouken@172
   183
								CFUUIDGetUUIDBytes (kIOHIDDeviceInterfaceID), (void *) &(pDevice->interface));
slouken@172
   184
			if (S_OK != plugInResult)
slouken@172
   185
				HIDReportErrorNum ("CouldnŐt query HID class device interface from plugInInterface", plugInResult);
slouken@172
   186
			(*ppPlugInInterface)->Release (ppPlugInInterface);
slouken@172
   187
		}
slouken@172
   188
		else
slouken@172
   189
			HIDReportErrorNum ("Failed to create **plugInInterface via IOCreatePlugInInterfaceForService.", result);
slouken@172
   190
	}
slouken@172
   191
	if (NULL != pDevice->interface)
slouken@172
   192
	{
slouken@172
   193
		result = (*(pDevice->interface))->open (pDevice->interface, 0);
slouken@172
   194
		if (kIOReturnSuccess != result)
slouken@172
   195
			HIDReportErrorNum ("Failed to open pDevice->interface via open.", result);
slouken@858
   196
		else
slouken@858
   197
			(*(pDevice->interface))->setRemovalCallback (pDevice->interface, HIDRemovalCallback, pDevice, pDevice);
slouken@858
   198
slouken@172
   199
	}
slouken@172
   200
	return result;
slouken@172
   201
}
slouken@172
   202
slouken@172
   203
/* Closes and releases interface to device, should be done prior to exting application
slouken@172
   204
 * Note: will have no affect if device or interface do not exist
slouken@172
   205
 * application will "own" the device if interface is not closed
slouken@172
   206
 * (device may have to be plug and re-plugged in different location to get it working again without a restart)
slouken@172
   207
 */
slouken@172
   208
icculus@1077
   209
static IOReturn HIDCloseReleaseInterface (recDevice *pDevice)
slouken@172
   210
{
slouken@172
   211
	IOReturn result = kIOReturnSuccess;
slouken@172
   212
	
slouken@172
   213
	if ((NULL != pDevice) && (NULL != pDevice->interface))
slouken@172
   214
	{
slouken@1487
   215
		/* close the interface */
slouken@172
   216
		result = (*(pDevice->interface))->close (pDevice->interface);
slouken@172
   217
		if (kIOReturnNotOpen == result)
slouken@172
   218
		{
slouken@1487
   219
			/* do nothing as device was not opened, thus can't be closed */
slouken@172
   220
		}
slouken@172
   221
		else if (kIOReturnSuccess != result)
slouken@172
   222
			HIDReportErrorNum ("Failed to close IOHIDDeviceInterface.", result);
slouken@1487
   223
		/* release the interface */
slouken@172
   224
		result = (*(pDevice->interface))->Release (pDevice->interface);
slouken@172
   225
		if (kIOReturnSuccess != result)
slouken@172
   226
			HIDReportErrorNum ("Failed to release IOHIDDeviceInterface.", result);
slouken@172
   227
		pDevice->interface = NULL;
slouken@172
   228
	}	
slouken@172
   229
	return result;
slouken@172
   230
}
slouken@172
   231
slouken@172
   232
/* extracts actual specific element information from each element CF dictionary entry */
slouken@172
   233
slouken@172
   234
static void HIDGetElementInfo (CFTypeRef refElement, recElement *pElement)
slouken@172
   235
{
slouken@172
   236
	long number;
slouken@172
   237
	CFTypeRef refType;
slouken@172
   238
slouken@172
   239
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementCookieKey));
slouken@172
   240
	if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number))
slouken@172
   241
		pElement->cookie = (IOHIDElementCookie) number;
slouken@172
   242
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementMinKey));
slouken@172
   243
	if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number))
slouken@172
   244
		pElement->min = number;
slouken@172
   245
		pElement->maxReport = pElement->min;
slouken@172
   246
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementMaxKey));
slouken@172
   247
	if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number))
slouken@172
   248
		pElement->max = number;
slouken@172
   249
		pElement->minReport = pElement->max;
slouken@172
   250
/*
slouken@172
   251
	TODO: maybe should handle the following stuff somehow?
slouken@172
   252
slouken@172
   253
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementScaledMinKey));
slouken@172
   254
	if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number))
slouken@172
   255
		pElement->scaledMin = number;
slouken@172
   256
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementScaledMaxKey));
slouken@172
   257
	if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number))
slouken@172
   258
		pElement->scaledMax = number;
slouken@172
   259
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementSizeKey));
slouken@172
   260
	if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number))
slouken@172
   261
		pElement->size = number;
slouken@172
   262
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementIsRelativeKey));
slouken@172
   263
	if (refType)
slouken@172
   264
		pElement->relative = CFBooleanGetValue (refType);
slouken@172
   265
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementIsWrappingKey));
slouken@172
   266
	if (refType)
slouken@172
   267
		pElement->wrapping = CFBooleanGetValue (refType);
slouken@172
   268
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementIsNonLinearKey));
slouken@172
   269
	if (refType)
slouken@172
   270
		pElement->nonLinear = CFBooleanGetValue (refType);
slouken@172
   271
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementHasPreferedStateKey));
slouken@172
   272
	if (refType)
slouken@172
   273
		pElement->preferredState = CFBooleanGetValue (refType);
slouken@172
   274
	refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementHasNullStateKey));
slouken@172
   275
	if (refType)
slouken@172
   276
		pElement->nullState = CFBooleanGetValue (refType);
slouken@172
   277
*/
slouken@172
   278
}			
slouken@172
   279
slouken@172
   280
/* examines CF dictionary vlaue in device element hierarchy to determine if it is element of interest or a collection of more elements
slouken@172
   281
 * if element of interest allocate storage, add to list and retrieve element specific info
slouken@172
   282
 * if collection then pass on to deconstruction collection into additional individual elements
slouken@172
   283
 */
slouken@172
   284
slouken@172
   285
static void HIDAddElement (CFTypeRef refElement, recDevice* pDevice)
slouken@172
   286
{
slouken@172
   287
	recElement* element = NULL;
slouken@172
   288
	recElement** headElement = NULL;
slouken@172
   289
	long elementType, usagePage, usage;
slouken@172
   290
	CFTypeRef refElementType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementTypeKey));
slouken@172
   291
	CFTypeRef refUsagePage = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementUsagePageKey));
slouken@172
   292
	CFTypeRef refUsage = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementUsageKey));
slouken@172
   293
slouken@172
   294
slouken@172
   295
	if ((refElementType) && (CFNumberGetValue (refElementType, kCFNumberLongType, &elementType)))
slouken@172
   296
	{
slouken@172
   297
		/* look at types of interest */
slouken@172
   298
		if ((elementType == kIOHIDElementTypeInput_Misc) || (elementType == kIOHIDElementTypeInput_Button) ||
slouken@172
   299
			(elementType == kIOHIDElementTypeInput_Axis))
slouken@172
   300
		{
slouken@172
   301
			if (refUsagePage && CFNumberGetValue (refUsagePage, kCFNumberLongType, &usagePage) &&
slouken@172
   302
				refUsage && CFNumberGetValue (refUsage, kCFNumberLongType, &usage))
slouken@172
   303
			{
slouken@172
   304
				switch (usagePage) /* only interested in kHIDPage_GenericDesktop and kHIDPage_Button */
slouken@172
   305
				{
slouken@172
   306
					case kHIDPage_GenericDesktop:
slouken@172
   307
						{
slouken@172
   308
							switch (usage) /* look at usage to determine function */
slouken@172
   309
							{
slouken@172
   310
								case kHIDUsage_GD_X:
slouken@172
   311
								case kHIDUsage_GD_Y:
slouken@172
   312
								case kHIDUsage_GD_Z:
slouken@172
   313
								case kHIDUsage_GD_Rx:
slouken@172
   314
								case kHIDUsage_GD_Ry:
slouken@172
   315
								case kHIDUsage_GD_Rz:
slouken@594
   316
								case kHIDUsage_GD_Slider:
slouken@594
   317
								case kHIDUsage_GD_Dial:
slouken@594
   318
								case kHIDUsage_GD_Wheel:
slouken@172
   319
									element = (recElement *) NewPtrClear (sizeof (recElement));
slouken@172
   320
									if (element)
slouken@172
   321
									{
slouken@172
   322
										pDevice->axes++;
slouken@172
   323
										headElement = &(pDevice->firstAxis);
slouken@172
   324
									}
slouken@172
   325
								break;
slouken@172
   326
								case kHIDUsage_GD_Hatswitch:
slouken@172
   327
									element = (recElement *) NewPtrClear (sizeof (recElement));
slouken@172
   328
									if (element)
slouken@172
   329
									{
slouken@172
   330
										pDevice->hats++;
slouken@172
   331
										headElement = &(pDevice->firstHat);
slouken@172
   332
									}
slouken@172
   333
								break;
slouken@172
   334
							}							
slouken@172
   335
						}
slouken@172
   336
						break;
slouken@172
   337
					case kHIDPage_Button:
slouken@172
   338
						element = (recElement *) NewPtrClear (sizeof (recElement));
slouken@172
   339
						if (element)
slouken@172
   340
						{
slouken@172
   341
							pDevice->buttons++;
slouken@172
   342
							headElement = &(pDevice->firstButton);
slouken@172
   343
						}
slouken@172
   344
						break;
slouken@172
   345
					default:
slouken@172
   346
						break;
slouken@172
   347
				}
slouken@172
   348
			}
slouken@172
   349
		}
slouken@172
   350
		else if (kIOHIDElementTypeCollection == elementType)
slouken@172
   351
			HIDGetCollectionElements ((CFMutableDictionaryRef) refElement, pDevice);
slouken@172
   352
	}
slouken@172
   353
slouken@172
   354
	if (element && headElement) /* add to list */
slouken@172
   355
	{
slouken@172
   356
		pDevice->elements++;
slouken@172
   357
		if (NULL == *headElement)
slouken@172
   358
			*headElement = element;
slouken@172
   359
		else
slouken@172
   360
		{
slouken@172
   361
			recElement *elementPrevious, *elementCurrent;
slouken@172
   362
			elementCurrent = *headElement;
slouken@172
   363
			while (elementCurrent)
slouken@172
   364
			{
slouken@172
   365
				elementPrevious = elementCurrent;
slouken@172
   366
				elementCurrent = elementPrevious->pNext;
slouken@172
   367
			}
slouken@172
   368
			elementPrevious->pNext = element;
slouken@172
   369
		}
slouken@172
   370
		element->pNext = NULL;
slouken@172
   371
		HIDGetElementInfo (refElement, element);
slouken@172
   372
	}
slouken@172
   373
}
slouken@172
   374
slouken@172
   375
/* collects information from each array member in device element list (each array memeber = element) */
slouken@172
   376
slouken@172
   377
static void HIDGetElementsCFArrayHandler (const void * value, void * parameter)
slouken@172
   378
{
slouken@172
   379
	if (CFGetTypeID (value) == CFDictionaryGetTypeID ())
slouken@172
   380
		HIDAddElement ((CFTypeRef) value, (recDevice *) parameter);
slouken@172
   381
}
slouken@172
   382
slouken@172
   383
/* handles retrieval of element information from arrays of elements in device IO registry information */
slouken@172
   384
slouken@172
   385
static void HIDGetElements (CFTypeRef refElementCurrent, recDevice *pDevice)
slouken@172
   386
{
slouken@172
   387
	CFTypeID type = CFGetTypeID (refElementCurrent);
slouken@172
   388
	if (type == CFArrayGetTypeID()) /* if element is an array */
slouken@172
   389
	{
slouken@172
   390
		CFRange range = {0, CFArrayGetCount (refElementCurrent)};
slouken@172
   391
		/* CountElementsCFArrayHandler called for each array member */
slouken@172
   392
		CFArrayApplyFunction (refElementCurrent, range, HIDGetElementsCFArrayHandler, pDevice);
slouken@172
   393
	}
slouken@172
   394
}			
slouken@172
   395
slouken@172
   396
/* handles extracting element information from element collection CF types
slouken@172
   397
 * used from top level element decoding and hierarchy deconstruction to flatten device element list
slouken@172
   398
 */
slouken@172
   399
slouken@172
   400
static void HIDGetCollectionElements (CFMutableDictionaryRef deviceProperties, recDevice *pDevice)
slouken@172
   401
{
slouken@172
   402
	CFTypeRef refElementTop = CFDictionaryGetValue (deviceProperties, CFSTR(kIOHIDElementKey));
slouken@172
   403
	if (refElementTop)
slouken@172
   404
		HIDGetElements (refElementTop, pDevice);
slouken@172
   405
}
slouken@172
   406
slouken@172
   407
/* use top level element usage page and usage to discern device usage page and usage setting appropriate vlaues in device record */
slouken@172
   408
slouken@172
   409
static void HIDTopLevelElementHandler (const void * value, void * parameter)
slouken@172
   410
{
slouken@172
   411
	CFTypeRef refCF = 0;
slouken@172
   412
	if (CFGetTypeID (value) != CFDictionaryGetTypeID ())
slouken@172
   413
		return;
slouken@172
   414
	refCF = CFDictionaryGetValue (value, CFSTR(kIOHIDElementUsagePageKey));
slouken@172
   415
	if (!CFNumberGetValue (refCF, kCFNumberLongType, &((recDevice *) parameter)->usagePage))
slouken@172
   416
		SDL_SetError ("CFNumberGetValue error retrieving pDevice->usagePage.");
slouken@172
   417
	refCF = CFDictionaryGetValue (value, CFSTR(kIOHIDElementUsageKey));
slouken@172
   418
	if (!CFNumberGetValue (refCF, kCFNumberLongType, &((recDevice *) parameter)->usage))
slouken@172
   419
		SDL_SetError ("CFNumberGetValue error retrieving pDevice->usage.");
slouken@172
   420
}
slouken@172
   421
slouken@172
   422
/* extracts device info from CF dictionary records in IO registry */
slouken@172
   423
slouken@172
   424
static void HIDGetDeviceInfo (io_object_t hidDevice, CFMutableDictionaryRef hidProperties, recDevice *pDevice)
slouken@172
   425
{
slouken@172
   426
	CFMutableDictionaryRef usbProperties = 0;
slouken@172
   427
	io_registry_entry_t parent1, parent2;
slouken@172
   428
	
slouken@172
   429
	/* Mac OS X currently is not mirroring all USB properties to HID page so need to look at USB device page also
slouken@172
   430
	 * get dictionary for usb properties: step up two levels and get CF dictionary for USB properties
slouken@172
   431
	 */
slouken@172
   432
	if ((KERN_SUCCESS == IORegistryEntryGetParentEntry (hidDevice, kIOServicePlane, &parent1)) &&
slouken@172
   433
		(KERN_SUCCESS == IORegistryEntryGetParentEntry (parent1, kIOServicePlane, &parent2)) &&
slouken@172
   434
		(KERN_SUCCESS == IORegistryEntryCreateCFProperties (parent2, &usbProperties, kCFAllocatorDefault, kNilOptions)))
slouken@172
   435
	{
slouken@172
   436
		if (usbProperties)
slouken@172
   437
		{
slouken@172
   438
			CFTypeRef refCF = 0;
slouken@172
   439
			/* get device info
slouken@172
   440
			 * try hid dictionary first, if fail then go to usb dictionary
slouken@172
   441
			 */
slouken@172
   442
			
slouken@172
   443
			
slouken@172
   444
			/* get product name */
slouken@172
   445
			refCF = CFDictionaryGetValue (hidProperties, CFSTR(kIOHIDProductKey));
slouken@172
   446
			if (!refCF)
slouken@172
   447
				refCF = CFDictionaryGetValue (usbProperties, CFSTR("USB Product Name"));
slouken@172
   448
			if (refCF)
slouken@172
   449
			{
slouken@172
   450
				if (!CFStringGetCString (refCF, pDevice->product, 256, CFStringGetSystemEncoding ()))
slouken@172
   451
					SDL_SetError ("CFStringGetCString error retrieving pDevice->product.");
slouken@172
   452
			}
slouken@172
   453
			
slouken@172
   454
			/* get usage page and usage */
slouken@172
   455
			refCF = CFDictionaryGetValue (hidProperties, CFSTR(kIOHIDPrimaryUsagePageKey));
slouken@172
   456
			if (refCF)
slouken@172
   457
			{
slouken@172
   458
				if (!CFNumberGetValue (refCF, kCFNumberLongType, &pDevice->usagePage))
slouken@172
   459
					SDL_SetError ("CFNumberGetValue error retrieving pDevice->usagePage.");
slouken@172
   460
				refCF = CFDictionaryGetValue (hidProperties, CFSTR(kIOHIDPrimaryUsageKey));
slouken@172
   461
				if (refCF)
slouken@172
   462
					if (!CFNumberGetValue (refCF, kCFNumberLongType, &pDevice->usage))
slouken@172
   463
						SDL_SetError ("CFNumberGetValue error retrieving pDevice->usage.");
slouken@172
   464
			}
slouken@172
   465
slouken@172
   466
			if (NULL == refCF) /* get top level element HID usage page or usage */
slouken@172
   467
			{
slouken@172
   468
				/* use top level element instead */
slouken@172
   469
				CFTypeRef refCFTopElement = 0;
slouken@172
   470
				refCFTopElement = CFDictionaryGetValue (hidProperties, CFSTR(kIOHIDElementKey));
slouken@172
   471
				{
slouken@172
   472
					/* refCFTopElement points to an array of element dictionaries */
slouken@172
   473
					CFRange range = {0, CFArrayGetCount (refCFTopElement)};
slouken@172
   474
					CFArrayApplyFunction (refCFTopElement, range, HIDTopLevelElementHandler, pDevice);
slouken@172
   475
				}
slouken@172
   476
			}
slouken@172
   477
slouken@172
   478
			CFRelease (usbProperties);
slouken@172
   479
		}
slouken@172
   480
		else
slouken@172
   481
			SDL_SetError ("IORegistryEntryCreateCFProperties failed to create usbProperties.");
slouken@172
   482
slouken@172
   483
		if (kIOReturnSuccess != IOObjectRelease (parent2))
slouken@172
   484
			SDL_SetError ("IOObjectRelease error with parent2.");
slouken@172
   485
		if (kIOReturnSuccess != IOObjectRelease (parent1))
slouken@172
   486
			SDL_SetError ("IOObjectRelease error with parent1.");
slouken@172
   487
	}
slouken@172
   488
}
slouken@172
   489
slouken@172
   490
slouken@172
   491
static recDevice *HIDBuildDevice (io_object_t hidDevice)
slouken@172
   492
{
slouken@172
   493
	recDevice *pDevice = (recDevice *) NewPtrClear (sizeof (recDevice));
slouken@172
   494
	if (pDevice)
slouken@172
   495
	{
slouken@172
   496
		/* get dictionary for HID properties */
slouken@172
   497
		CFMutableDictionaryRef hidProperties = 0;
slouken@172
   498
		kern_return_t result = IORegistryEntryCreateCFProperties (hidDevice, &hidProperties, kCFAllocatorDefault, kNilOptions);
slouken@172
   499
		if ((result == KERN_SUCCESS) && hidProperties)
slouken@172
   500
		{
slouken@172
   501
			/* create device interface */
slouken@172
   502
			result = HIDCreateOpenDeviceInterface (hidDevice, pDevice);
slouken@172
   503
			if (kIOReturnSuccess == result)
slouken@172
   504
			{
slouken@172
   505
				HIDGetDeviceInfo (hidDevice, hidProperties, pDevice); /* hidDevice used to find parents in registry tree */
slouken@172
   506
				HIDGetCollectionElements (hidProperties, pDevice);
slouken@172
   507
			}
slouken@172
   508
			else
slouken@172
   509
			{
slouken@210
   510
				DisposePtr((Ptr)pDevice);
slouken@172
   511
				pDevice = NULL;
slouken@172
   512
			}
slouken@172
   513
			CFRelease (hidProperties);
slouken@172
   514
		}
slouken@172
   515
		else
slouken@172
   516
		{
slouken@210
   517
			DisposePtr((Ptr)pDevice);
slouken@172
   518
			pDevice = NULL;
slouken@172
   519
		}
slouken@172
   520
	}
slouken@172
   521
	return pDevice;
slouken@172
   522
}
slouken@172
   523
slouken@172
   524
/* disposes of the element list associated with a device and the memory associated with the list
slouken@172
   525
 */
slouken@172
   526
slouken@172
   527
static void HIDDisposeElementList (recElement **elementList)
slouken@172
   528
{
slouken@172
   529
	recElement *pElement = *elementList;
slouken@172
   530
	while (pElement)
slouken@172
   531
	{
slouken@172
   532
		recElement *pElementNext = pElement->pNext;
slouken@172
   533
		DisposePtr ((Ptr) pElement);
slouken@172
   534
		pElement = pElementNext;
slouken@172
   535
	}
slouken@172
   536
	*elementList = NULL;
slouken@172
   537
}
slouken@172
   538
slouken@172
   539
/* disposes of a single device, closing and releaseing interface, freeing memory fro device and elements, setting device pointer to NULL
slouken@172
   540
 * all your device no longer belong to us... (i.e., you do not 'own' the device anymore)
slouken@172
   541
 */
slouken@172
   542
slouken@172
   543
static recDevice *HIDDisposeDevice (recDevice **ppDevice)
slouken@172
   544
{
slouken@172
   545
	kern_return_t result = KERN_SUCCESS;
slouken@172
   546
	recDevice *pDeviceNext = NULL;
slouken@172
   547
	if (*ppDevice)
slouken@172
   548
	{
slouken@1487
   549
		/* save next device prior to disposing of this device */
slouken@172
   550
		pDeviceNext = (*ppDevice)->pNext;
slouken@172
   551
		
slouken@172
   552
		/* free element lists */
slouken@172
   553
		HIDDisposeElementList (&(*ppDevice)->firstAxis);
slouken@172
   554
		HIDDisposeElementList (&(*ppDevice)->firstButton);
slouken@172
   555
		HIDDisposeElementList (&(*ppDevice)->firstHat);
slouken@172
   556
		
slouken@172
   557
		result = HIDCloseReleaseInterface (*ppDevice); /* function sanity checks interface value (now application does not own device) */
slouken@172
   558
		if (kIOReturnSuccess != result)
slouken@172
   559
			HIDReportErrorNum ("HIDCloseReleaseInterface failed when trying to dipose device.", result);
slouken@172
   560
		DisposePtr ((Ptr)*ppDevice);
slouken@172
   561
		*ppDevice = NULL;
slouken@172
   562
	}
slouken@172
   563
	return pDeviceNext;
slouken@172
   564
}
slouken@172
   565
slouken@172
   566
slouken@172
   567
/* Function to scan the system for joysticks.
slouken@172
   568
 * Joystick 0 should be the system default joystick.
slouken@172
   569
 * This function should return the number of available joysticks, or -1
slouken@172
   570
 * on an unrecoverable fatal error.
slouken@172
   571
 */
slouken@172
   572
int SDL_SYS_JoystickInit(void)
slouken@172
   573
{
slouken@172
   574
	IOReturn result = kIOReturnSuccess;
slouken@1409
   575
	mach_port_t masterPort = 0;
slouken@1409
   576
	io_iterator_t hidObjectIterator = 0;
slouken@172
   577
	CFMutableDictionaryRef hidMatchDictionary = NULL;
slouken@172
   578
	recDevice *device, *lastDevice;
slouken@1409
   579
	io_object_t ioHIDDeviceObject = 0;
slouken@172
   580
	
slouken@172
   581
	SDL_numjoysticks = 0;
slouken@172
   582
	
slouken@1496
   583
	if (gpDeviceList)
slouken@172
   584
	{
slouken@172
   585
		SDL_SetError("Joystick: Device list already inited.");
slouken@172
   586
		return -1;
slouken@172
   587
	}
slouken@172
   588
	
slouken@172
   589
	result = IOMasterPort (bootstrap_port, &masterPort);
slouken@172
   590
	if (kIOReturnSuccess != result)
slouken@172
   591
	{
slouken@172
   592
		SDL_SetError("Joystick: IOMasterPort error with bootstrap_port.");
slouken@172
   593
		return -1;
slouken@172
   594
	}
slouken@172
   595
slouken@172
   596
	/* Set up a matching dictionary to search I/O Registry by class name for all HID class devices. */
slouken@172
   597
	hidMatchDictionary = IOServiceMatching (kIOHIDDeviceKey);
slouken@1409
   598
	if (hidMatchDictionary)
slouken@172
   599
	{
slouken@172
   600
		/* Add key for device type (joystick, in this case) to refine the matching dictionary. */
slouken@495
   601
		
slouken@495
   602
		/* NOTE: we now perform this filtering later
slouken@495
   603
		UInt32 usagePage = kHIDPage_GenericDesktop;
slouken@495
   604
		UInt32 usage = kHIDUsage_GD_Joystick;
slouken@172
   605
		CFNumberRef refUsage = NULL, refUsagePage = NULL;
slouken@172
   606
slouken@475
   607
		refUsage = CFNumberCreate (kCFAllocatorDefault, kCFNumberIntType, &usage);
slouken@172
   608
		CFDictionarySetValue (hidMatchDictionary, CFSTR (kIOHIDPrimaryUsageKey), refUsage);
slouken@475
   609
		refUsagePage = CFNumberCreate (kCFAllocatorDefault, kCFNumberIntType, &usagePage);
slouken@172
   610
		CFDictionarySetValue (hidMatchDictionary, CFSTR (kIOHIDPrimaryUsagePageKey), refUsagePage);
slouken@495
   611
		*/
slouken@172
   612
	}
slouken@172
   613
	else
slouken@172
   614
	{
slouken@172
   615
		SDL_SetError("Joystick: Failed to get HID CFMutableDictionaryRef via IOServiceMatching.");
slouken@172
   616
		return -1;
slouken@172
   617
	}
slouken@172
   618
	
slouken@172
   619
	/*/ Now search I/O Registry for matching devices. */
slouken@172
   620
	result = IOServiceGetMatchingServices (masterPort, hidMatchDictionary, &hidObjectIterator);
slouken@172
   621
	/* Check for errors */
slouken@427
   622
	if (kIOReturnSuccess != result)
slouken@172
   623
	{
slouken@172
   624
		SDL_SetError("Joystick: Couldn't create a HID object iterator.");
slouken@172
   625
		return -1;
slouken@172
   626
	}
slouken@1409
   627
	if (!hidObjectIterator) /* there are no joysticks */
slouken@427
   628
	{
slouken@427
   629
		gpDeviceList = NULL;
slouken@427
   630
		SDL_numjoysticks = 0;
slouken@427
   631
		return 0;
slouken@427
   632
	}
slouken@172
   633
	/* IOServiceGetMatchingServices consumes a reference to the dictionary, so we don't need to release the dictionary ref. */
slouken@172
   634
slouken@172
   635
	/* build flat linked list of devices from device iterator */
slouken@172
   636
slouken@172
   637
	gpDeviceList = lastDevice = NULL;
slouken@172
   638
	
slouken@172
   639
	while ((ioHIDDeviceObject = IOIteratorNext (hidObjectIterator)))
slouken@172
   640
	{
slouken@172
   641
		/* build a device record */
slouken@172
   642
		device = HIDBuildDevice (ioHIDDeviceObject);
slouken@172
   643
		if (!device)
slouken@172
   644
			continue;
slouken@172
   645
slouken@172
   646
		/* dump device object, it is no longer needed */
slouken@172
   647
		result = IOObjectRelease (ioHIDDeviceObject);
slouken@1487
   648
/*		if (KERN_SUCCESS != result)
slouken@1487
   649
			HIDReportErrorNum ("IOObjectRelease error with ioHIDDeviceObject.", result);
slouken@1487
   650
*/
slouken@495
   651
slouken@495
   652
		/* Filter device list to non-keyboard/mouse stuff */ 
icculus@623
   653
		if ( (device->usagePage != kHIDPage_GenericDesktop) ||
icculus@623
   654
		     ((device->usage != kHIDUsage_GD_Joystick &&
icculus@623
   655
		      device->usage != kHIDUsage_GD_GamePad)) ) {
icculus@620
   656
slouken@495
   657
			/* release memory for the device */
slouken@495
   658
			HIDDisposeDevice (&device);
slouken@495
   659
			DisposePtr((Ptr)device);
slouken@495
   660
			continue;
slouken@495
   661
		}
slouken@495
   662
		
slouken@172
   663
		/* Add device to the end of the list */
slouken@172
   664
		if (lastDevice)
slouken@172
   665
			lastDevice->pNext = device;
slouken@172
   666
		else
slouken@172
   667
			gpDeviceList = device;
slouken@172
   668
		lastDevice = device;
slouken@172
   669
	}
slouken@172
   670
	result = IOObjectRelease (hidObjectIterator); /* release the iterator */
slouken@172
   671
slouken@172
   672
	/* Count the total number of devices we found */
slouken@172
   673
	device = gpDeviceList;
slouken@172
   674
	while (device)
slouken@172
   675
	{
slouken@172
   676
		SDL_numjoysticks++;
slouken@172
   677
		device = device->pNext;
slouken@172
   678
	}
slouken@172
   679
	
slouken@172
   680
	return SDL_numjoysticks;
slouken@172
   681
}
slouken@172
   682
slouken@172
   683
/* Function to get the device-dependent name of a joystick */
slouken@172
   684
const char *SDL_SYS_JoystickName(int index)
slouken@172
   685
{
slouken@172
   686
	recDevice *device = gpDeviceList;
slouken@172
   687
	
slouken@172
   688
	for (; index > 0; index--)
slouken@172
   689
		device = device->pNext;
slouken@172
   690
slouken@172
   691
	return device->product;
slouken@172
   692
}
slouken@172
   693
slouken@172
   694
/* Function to open a joystick for use.
slouken@172
   695
 * The joystick to open is specified by the index field of the joystick.
slouken@172
   696
 * This should fill the nbuttons and naxes fields of the joystick structure.
slouken@172
   697
 * It returns 0, or -1 if there is an error.
slouken@172
   698
 */
slouken@172
   699
int SDL_SYS_JoystickOpen(SDL_Joystick *joystick)
slouken@172
   700
{
slouken@172
   701
	recDevice *device = gpDeviceList;
slouken@172
   702
	int index;
slouken@172
   703
	
slouken@172
   704
	for (index = joystick->index; index > 0; index--)
slouken@172
   705
		device = device->pNext;
slouken@172
   706
slouken@172
   707
	joystick->hwdata = device;
slouken@172
   708
	joystick->name = device->product;
slouken@172
   709
slouken@172
   710
	joystick->naxes = device->axes;
slouken@172
   711
	joystick->nhats = device->hats;
slouken@172
   712
	joystick->nballs = 0;
slouken@172
   713
	joystick->nbuttons = device->buttons;
slouken@172
   714
slouken@172
   715
	return 0;
slouken@172
   716
}
slouken@172
   717
slouken@172
   718
/* Function to update the state of a joystick - called as a device poll.
slouken@172
   719
 * This function shouldn't update the joystick structure directly,
slouken@172
   720
 * but instead should call SDL_PrivateJoystick*() to deliver events
slouken@172
   721
 * and update joystick device state.
slouken@172
   722
 */
slouken@172
   723
void SDL_SYS_JoystickUpdate(SDL_Joystick *joystick)
slouken@172
   724
{
slouken@172
   725
	recDevice *device = joystick->hwdata;
slouken@172
   726
	recElement *element;
slouken@172
   727
	SInt32 value;
slouken@172
   728
	int i;
slouken@858
   729
slouken@858
   730
	if (device->removed)  /* device was unplugged; ignore it. */
slouken@858
   731
	{
slouken@858
   732
		if (device->uncentered)
slouken@858
   733
		{
slouken@858
   734
			device->uncentered = 0;
slouken@858
   735
slouken@858
   736
			/* Tell the app that everything is centered/unpressed... */
slouken@858
   737
			for (i = 0; i < device->axes; i++)
slouken@858
   738
				SDL_PrivateJoystickAxis(joystick, i, 0);
slouken@858
   739
slouken@858
   740
			for (i = 0; i < device->buttons; i++)
slouken@858
   741
				SDL_PrivateJoystickButton(joystick, i, 0);
slouken@858
   742
slouken@858
   743
			for (i = 0; i < device->hats; i++)
slouken@858
   744
				SDL_PrivateJoystickHat(joystick, i, SDL_HAT_CENTERED);
slouken@858
   745
		}
slouken@858
   746
slouken@858
   747
		return;
slouken@858
   748
	}
slouken@858
   749
slouken@172
   750
	element = device->firstAxis;
slouken@172
   751
	i = 0;
slouken@172
   752
	while (element)
slouken@172
   753
	{
slouken@172
   754
		value = HIDScaledCalibratedValue(device, element, -32768, 32767);
slouken@172
   755
		if ( value != joystick->axes[i] )
slouken@172
   756
			SDL_PrivateJoystickAxis(joystick, i, value);
slouken@172
   757
		element = element->pNext;
slouken@172
   758
		++i;
slouken@172
   759
	}
slouken@172
   760
	
slouken@172
   761
	element = device->firstButton;
slouken@172
   762
	i = 0;
slouken@172
   763
	while (element)
slouken@172
   764
	{
slouken@172
   765
		value = HIDGetElementValue(device, element);
slouken@629
   766
        if (value > 1)  /* handle pressure-sensitive buttons */
slouken@629
   767
            value = 1;
slouken@172
   768
		if ( value != joystick->buttons[i] )
slouken@172
   769
			SDL_PrivateJoystickButton(joystick, i, value);
slouken@172
   770
		element = element->pNext;
slouken@172
   771
		++i;
slouken@172
   772
	}
slouken@629
   773
	    
slouken@172
   774
	element = device->firstHat;
slouken@172
   775
	i = 0;
slouken@172
   776
	while (element)
slouken@172
   777
	{
slouken@210
   778
		Uint8 pos = 0;
slouken@172
   779
slouken@172
   780
		value = HIDGetElementValue(device, element);
slouken@617
   781
		if (element->max == 3) /* 4 position hatswitch - scale up value */
slouken@617
   782
			value *= 2;
slouken@617
   783
		else if (element->max != 7) /* Neither a 4 nor 8 positions - fall back to default position (centered) */
slouken@617
   784
			value = -1;
slouken@172
   785
		switch(value)
slouken@172
   786
		{
slouken@172
   787
			case 0:
slouken@617
   788
				pos = SDL_HAT_UP;
slouken@172
   789
				break;
slouken@172
   790
			case 1:
slouken@617
   791
				pos = SDL_HAT_RIGHTUP;
slouken@172
   792
				break;
slouken@172
   793
			case 2:
slouken@617
   794
				pos = SDL_HAT_RIGHT;
slouken@172
   795
				break;
slouken@172
   796
			case 3:
slouken@617
   797
				pos = SDL_HAT_RIGHTDOWN;
slouken@172
   798
				break;
slouken@172
   799
			case 4:
slouken@617
   800
				pos = SDL_HAT_DOWN;
slouken@172
   801
				break;
slouken@172
   802
			case 5:
slouken@617
   803
				pos = SDL_HAT_LEFTDOWN;
slouken@172
   804
				break;
slouken@172
   805
			case 6:
slouken@617
   806
				pos = SDL_HAT_LEFT;
slouken@172
   807
				break;
slouken@172
   808
			case 7:
slouken@617
   809
				pos = SDL_HAT_LEFTUP;
slouken@172
   810
				break;
slouken@617
   811
			default:
slouken@617
   812
				/* Every other value is mapped to center. We do that because some
slouken@617
   813
				 * joysticks use 8 and some 15 for this value, and apparently
slouken@617
   814
				 * there are even more variants out there - so we try to be generous.
slouken@617
   815
				 */
slouken@617
   816
				pos = SDL_HAT_CENTERED;
slouken@172
   817
				break;
slouken@172
   818
		}
slouken@172
   819
		if ( pos != joystick->hats[i] )
slouken@172
   820
			SDL_PrivateJoystickHat(joystick, i, pos);
slouken@172
   821
		element = element->pNext;
slouken@172
   822
		++i;
slouken@172
   823
	}
slouken@172
   824
	
slouken@172
   825
	return;
slouken@172
   826
}
slouken@172
   827
slouken@172
   828
/* Function to close a joystick after use */
slouken@172
   829
void SDL_SYS_JoystickClose(SDL_Joystick *joystick)
slouken@172
   830
{
slouken@172
   831
	/* Should we do anything here? */
slouken@172
   832
	return;
slouken@172
   833
}
slouken@172
   834
slouken@172
   835
/* Function to perform any system-specific joystick related cleanup */
slouken@172
   836
void SDL_SYS_JoystickQuit(void)
slouken@172
   837
{
slouken@172
   838
	while (NULL != gpDeviceList)
slouken@172
   839
		gpDeviceList = HIDDisposeDevice (&gpDeviceList);
slouken@172
   840
}
slouken@1635
   841
slouken@1635
   842
#endif /* SDL_JOYSTICK_IOKIT */