SDL_sysjoystick.c
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
22
#include "SDL_config.h"
23
24
25
26
27
28
29
30
/*
* Joystick driver for the uhid(4) interface found in OpenBSD,
* NetBSD and FreeBSD.
*
* Maintainer: <vedge at csoft.org>
*/
31
32
#include <sys/param.h>
33
34
35
36
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
37
38
39
#if defined(HAVE_USB_H)
#include <usb.h>
#endif
44
45
#include <dev/usb/usb.h>
#include <dev/usb/usbhid.h>
48
49
50
51
52
53
#if defined(HAVE_USBHID_H)
#include <usbhid.h>
#elif defined(HAVE_LIBUSB_H)
#include <libusb.h>
#elif defined(HAVE_LIBUSBHID_H)
#include <libusbhid.h>
56
#ifdef __FREEBSD__
58
#include <osreldate.h>
60
61
62
#include <sys/joystick.h>
#endif
64
#include <machine/joystick.h>
67
#include "SDL_joystick.h"
68
69
#include "../SDL_sysjoystick.h"
#include "../SDL_joystick_c.h"
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
#define MAX_UHID_JOYS 4
#define MAX_JOY_JOYS 2
#define MAX_JOYS (MAX_UHID_JOYS + MAX_JOY_JOYS)
struct report {
struct usb_ctl_report *buf; /* Buffer */
size_t size; /* Buffer size */
int rid; /* Report ID */
enum {
SREPORT_UNINIT,
SREPORT_CLEAN,
SREPORT_DIRTY
} status;
};
static struct {
int uhid_report;
88
hid_kind_t kind;
89
90
91
92
93
94
const char *name;
} const repinfo[] = {
{ UHID_INPUT_REPORT, hid_input, "input" },
{ UHID_OUTPUT_REPORT, hid_output, "output" },
{ UHID_FEATURE_REPORT, hid_feature, "feature" }
};
95
96
97
98
99
100
101
102
103
104
105
106
enum {
REPORT_INPUT = 0,
REPORT_OUTPUT = 1,
REPORT_FEATURE = 2
};
enum {
JOYAXE_X,
JOYAXE_Y,
JOYAXE_Z,
JOYAXE_SLIDER,
107
108
109
110
111
JOYAXE_WHEEL,
JOYAXE_RX,
JOYAXE_RY,
JOYAXE_RZ,
JOYAXE_count
113
114
115
116
117
118
119
120
121
122
struct joystick_hwdata {
int fd;
char *path;
enum {
BSDJOY_UHID, /* uhid(4) */
BSDJOY_JOY /* joy(4) */
} type;
struct report_desc *repdesc;
struct report inreport;
123
int axis_map[JOYAXE_count]; /* map present JOYAXE_* to 0,1,..*/
124
125
126
127
128
129
130
131
};
static char *joynames[MAX_JOYS];
static char *joydevnames[MAX_JOYS];
static int report_alloc(struct report *, struct report_desc *, int);
static void report_free(struct report *);
132
133
134
135
136
137
#ifdef USBHID_UCR_DATA
#define REP_BUF_DATA(rep) ((rep)->buf->ucr_data)
#else
#define REP_BUF_DATA(rep) ((rep)->buf->data)
#endif
138
139
140
int
SDL_SYS_JoystickInit(void)
{
142
143
144
145
int i, fd;
SDL_numjoysticks = 0;
146
147
SDL_memset(joynames, 0, sizeof(joynames));
SDL_memset(joydevnames, 0, sizeof(joydevnames));
148
149
for (i = 0; i < MAX_UHID_JOYS; i++) {
150
151
SDL_Joystick nj;
152
SDL_snprintf(s, SDL_arraysize(s), "/dev/uhid%d", i);
153
154
155
156
157
158
159
160
nj.index = SDL_numjoysticks;
joynames[nj.index] = strdup(s);
if (SDL_SYS_JoystickOpen(&nj) == 0) {
SDL_SYS_JoystickClose(&nj);
SDL_numjoysticks++;
} else {
161
SDL_free(joynames[nj.index]);
162
joynames[nj.index] = NULL;
163
164
165
}
}
for (i = 0; i < MAX_JOY_JOYS; i++) {
166
SDL_snprintf(s, SDL_arraysize(s), "/dev/joy%d", i);
167
168
fd = open(s, O_RDONLY);
if (fd != -1) {
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
joynames[SDL_numjoysticks++] = strdup(s);
close(fd);
}
}
/* Read the default USB HID usage table. */
hid_init(NULL);
return (SDL_numjoysticks);
}
const char *
SDL_SYS_JoystickName(int index)
{
if (joydevnames[index] != NULL) {
return (joydevnames[index]);
}
return (joynames[index]);
}
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
static int
usage_to_joyaxe(unsigned usage)
{
int joyaxe;
switch (usage) {
case HUG_X:
joyaxe = JOYAXE_X; break;
case HUG_Y:
joyaxe = JOYAXE_Y; break;
case HUG_Z:
joyaxe = JOYAXE_Z; break;
case HUG_SLIDER:
joyaxe = JOYAXE_SLIDER; break;
case HUG_WHEEL:
joyaxe = JOYAXE_WHEEL; break;
case HUG_RX:
joyaxe = JOYAXE_RX; break;
case HUG_RY:
joyaxe = JOYAXE_RY; break;
case HUG_RZ:
joyaxe = JOYAXE_RZ; break;
default:
joyaxe = -1;
}
return joyaxe;
}
static unsigned
hatval_to_sdl(Sint32 hatval)
{
static const unsigned hat_dir_map[8] = {
SDL_HAT_UP, SDL_HAT_RIGHTUP, SDL_HAT_RIGHT, SDL_HAT_RIGHTDOWN,
SDL_HAT_DOWN, SDL_HAT_LEFTDOWN, SDL_HAT_LEFT, SDL_HAT_LEFTUP
};
unsigned result;
if ((hatval & 7) == hatval)
result = hat_dir_map[hatval];
else
result = SDL_HAT_CENTERED;
return result;
}
232
233
234
235
236
237
238
239
240
int
SDL_SYS_JoystickOpen(SDL_Joystick *joy)
{
char *path = joynames[joy->index];
struct joystick_hwdata *hw;
struct hid_item hitem;
struct hid_data *hdata;
struct report *rep;
int fd;
243
fd = open(path, O_RDONLY);
244
if (fd == -1) {
245
246
247
248
SDL_SetError("%s: %s", path, strerror(errno));
return (-1);
}
249
hw = (struct joystick_hwdata *)SDL_malloc(sizeof(struct joystick_hwdata));
250
251
252
253
254
255
256
257
if (hw == NULL) {
SDL_OutOfMemory();
close(fd);
return (-1);
}
joy->hwdata = hw;
hw->fd = fd;
hw->path = strdup(path);
258
if (! SDL_strncmp(path, "/dev/joy", 8)) {
259
260
261
262
263
264
265
266
267
268
269
hw->type = BSDJOY_JOY;
joy->naxes = 2;
joy->nbuttons = 2;
joy->nhats = 0;
joy->nballs = 0;
joydevnames[joy->index] = strdup("Gameport joystick");
goto usbend;
} else {
hw->type = BSDJOY_UHID;
}
270
271
272
273
274
{
int ax;
for (ax = 0; ax < JOYAXE_count; ax++)
hw->axis_map[ax] = -1;
}
275
276
277
278
279
280
281
282
hw->repdesc = hid_get_report_desc(fd);
if (hw->repdesc == NULL) {
SDL_SetError("%s: USB_GET_REPORT_DESC: %s", hw->path,
strerror(errno));
goto usberr;
}
rep = &hw->inreport;
283
284
285
if (ioctl(fd, USB_GET_REPORT_ID, &rep->rid) < 0) {
rep->rid = -1; /* XXX */
}
286
287
288
289
if (report_alloc(rep, hw->repdesc, REPORT_INPUT) < 0) {
goto usberr;
}
if (rep->size <= 0) {
290
291
SDL_SetError("%s: Input report descriptor has invalid length",
hw->path);
292
293
294
goto usberr;
}
295
#if defined(USBHID_NEW) || (defined(__FREEBSD__) && __FreeBSD_version >= 500111)
296
297
hdata = hid_start_parse(hw->repdesc, 1 << hid_input, rep->rid);
#else
298
hdata = hid_start_parse(hw->repdesc, 1 << hid_input);
300
301
302
303
304
305
306
307
if (hdata == NULL) {
SDL_SetError("%s: Cannot start HID parser", hw->path);
goto usberr;
}
joy->naxes = 0;
joy->nbuttons = 0;
joy->nhats = 0;
joy->nballs = 0;
310
311
while (hid_get_item(hdata, &hitem) > 0) {
312
313
char *sp;
const char *s;
314
315
316
317
318
319
320
321
322
switch (hitem.kind) {
case hid_collection:
switch (HID_PAGE(hitem.usage)) {
case HUP_GENERIC_DESKTOP:
switch (HID_USAGE(hitem.usage)) {
case HUG_JOYSTICK:
case HUG_GAME_PAD:
s = hid_usage_in_page(hitem.usage);
323
sp = SDL_malloc(SDL_strlen(s) + 5);
324
SDL_snprintf(sp, SDL_strlen(s) + 5, "%s (%d)", s,
325
326
327
328
329
330
331
joy->index);
joydevnames[joy->index] = sp;
}
}
break;
case hid_input:
switch (HID_PAGE(hitem.usage)) {
332
333
334
335
case HUP_GENERIC_DESKTOP: {
unsigned usage = HID_USAGE(hitem.usage);
int joyaxe = usage_to_joyaxe(usage);
if (joyaxe >= 0) {
337
338
339
340
341
} else if (usage == HUG_HAT_SWITCH) {
joy->nhats++;
}
break;
}
342
343
344
case HUP_BUTTON:
joy->nbuttons++;
break;
345
346
default:
break;
347
348
349
350
351
352
353
}
break;
default:
break;
}
}
hid_end_parse(hdata);
354
355
356
for (i=0; i<JOYAXE_count; i++)
if (hw->axis_map[i] > 0)
hw->axis_map[i] = joy->naxes++;
359
360
361
362
363
364
/* The poll blocks the event thread. */
fcntl(fd, F_SETFL, O_NONBLOCK);
return (0);
usberr:
close(hw->fd);
365
366
SDL_free(hw->path);
SDL_free(hw);
367
368
369
370
371
372
return (-1);
}
void
SDL_SYS_JoystickUpdate(SDL_Joystick *joy)
{
373
374
375
struct hid_item hitem;
struct hid_data *hdata;
struct report *rep;
376
int nbutton, naxe = -1;
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
struct joystick gameport;
static int x, y, xmin = 0xffff, ymin = 0xffff, xmax = 0, ymax = 0;
if (joy->hwdata->type == BSDJOY_JOY) {
if (read(joy->hwdata->fd, &gameport, sizeof gameport) != sizeof gameport)
return;
if (abs(x - gameport.x) > 8) {
x = gameport.x;
if (x < xmin) {
xmin = x;
}
if (x > xmax) {
xmax = x;
}
if (xmin == xmax) {
xmin--;
xmax++;
}
v = (Sint32)x;
v -= (xmax + xmin + 1)/2;
v *= 32768/((xmax - xmin + 1)/2);
SDL_PrivateJoystickAxis(joy, 0, v);
}
if (abs(y - gameport.y) > 8) {
y = gameport.y;
if (y < ymin) {
ymin = y;
}
if (y > ymax) {
ymax = y;
}
if (ymin == ymax) {
ymin--;
ymax++;
}
v = (Sint32)y;
v -= (ymax + ymin + 1)/2;
v *= 32768/((ymax - ymin + 1)/2);
SDL_PrivateJoystickAxis(joy, 1, v);
}
if (gameport.b1 != joy->buttons[0]) {
SDL_PrivateJoystickButton(joy, 0, gameport.b1);
}
if (gameport.b2 != joy->buttons[1]) {
SDL_PrivateJoystickButton(joy, 1, gameport.b2);
}
return;
}
429
430
rep = &joy->hwdata->inreport;
431
432
if (read(joy->hwdata->fd, REP_BUF_DATA(rep), rep->size) != rep->size) {
433
434
return;
}
435
#if defined(USBHID_NEW) || (defined(__FREEBSD__) && __FreeBSD_version >= 500111)
436
437
hdata = hid_start_parse(joy->hwdata->repdesc, 1 << hid_input, rep->rid);
#else
438
hdata = hid_start_parse(joy->hwdata->repdesc, 1 << hid_input);
440
441
442
443
444
445
if (hdata == NULL) {
fprintf(stderr, "%s: Cannot start HID parser\n",
joy->hwdata->path);
return;
}
446
for (nbutton = 0; hid_get_item(hdata, &hitem) > 0;) {
447
448
449
switch (hitem.kind) {
case hid_input:
switch (HID_PAGE(hitem.usage)) {
450
451
452
453
454
455
case HUP_GENERIC_DESKTOP: {
unsigned usage = HID_USAGE(hitem.usage);
int joyaxe = usage_to_joyaxe(usage);
if (joyaxe >= 0) {
naxe = joy->hwdata->axis_map[joyaxe];
/* scaleaxe */
456
v = (Sint32)hid_get_data(REP_BUF_DATA(rep),
457
&hitem);
458
459
v -= (hitem.logical_maximum + hitem.logical_minimum + 1)/2;
v *= 32768/((hitem.logical_maximum - hitem.logical_minimum + 1)/2);
460
if (v != joy->axes[naxe]) {
461
SDL_PrivateJoystickAxis(joy, naxe, v);
463
464
465
} else if (usage == HUG_HAT_SWITCH) {
v = (Sint32)hid_get_data(REP_BUF_DATA(rep),
&hitem);
468
469
470
}
break;
}
471
case HUP_BUTTON:
472
v = (Sint32)hid_get_data(REP_BUF_DATA(rep),
474
475
476
477
478
479
if (joy->buttons[nbutton] != v) {
SDL_PrivateJoystickButton(joy,
nbutton, v);
}
nbutton++;
break;
480
481
default:
continue;
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
}
break;
default:
break;
}
}
hid_end_parse(hdata);
return;
}
/* Function to close a joystick after use */
void
SDL_SYS_JoystickClose(SDL_Joystick *joy)
{
497
if (SDL_strncmp(joy->hwdata->path, "/dev/joy", 8)) {
498
499
500
report_free(&joy->hwdata->inreport);
hid_dispose_report_desc(joy->hwdata->repdesc);
}
501
close(joy->hwdata->fd);
502
503
SDL_free(joy->hwdata->path);
SDL_free(joy->hwdata);
504
505
506
507
508
509
510
511
512
513
514
return;
}
void
SDL_SYS_JoystickQuit(void)
{
int i;
for (i = 0; i < MAX_JOYS; i++) {
if (joynames[i] != NULL)
515
SDL_free(joynames[i]);
516
if (joydevnames[i] != NULL)
517
SDL_free(joydevnames[i]);
518
519
520
521
522
523
524
525
526
527
}
return;
}
static int
report_alloc(struct report *r, struct report_desc *rd, int repind)
{
int len;
528
529
530
#ifdef __DragonFly__
len = hid_report_size(rd, r->rid, repinfo[repind].kind);
#elif __FREEBSD__
531
# if (__FreeBSD_version >= 460000)
532
# if (__FreeBSD_version <= 500111)
533
len = hid_report_size(rd, r->rid, repinfo[repind].kind);
534
535
536
# else
len = hid_report_size(rd, repinfo[repind].kind, r->rid);
# endif
537
538
# else
len = hid_report_size(rd, repinfo[repind].kind, &r->rid);
541
542
# ifdef USBHID_NEW
len = hid_report_size(rd, repinfo[repind].kind, r->rid);
545
# endif
548
549
550
551
552
553
554
if (len < 0) {
SDL_SetError("Negative HID report size");
return (-1);
}
r->size = len;
if (r->size > 0) {
555
r->buf = SDL_malloc(sizeof(*r->buf) - sizeof(REP_BUF_DATA(r)) +
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
r->size);
if (r->buf == NULL) {
SDL_OutOfMemory();
return (-1);
}
} else {
r->buf = NULL;
}
r->status = SREPORT_CLEAN;
return (0);
}
static void
report_free(struct report *r)
{
if (r->buf != NULL) {
573
SDL_free(r->buf);
574
575
576
}
r->status = SREPORT_UNINIT;
}