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