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