SDL_sysjoystick.c
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2012 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"
24
25
#ifdef SDL_JOYSTICK_USBHID
26
27
28
29
30
31
32
/*
* Joystick driver for the uhid(4) interface found in OpenBSD,
* NetBSD and FreeBSD.
*
* Maintainer: <vedge at csoft.org>
*/
33
34
#include <sys/param.h>
35
36
37
38
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
39
40
41
42
#ifndef __FreeBSD_kernel_version
#define __FreeBSD_kernel_version __FreeBSD_version
#endif
43
44
45
#if defined(HAVE_USB_H)
#include <usb.h>
#endif
50
51
#include <dev/usb/usb.h>
#include <dev/usb/usbhid.h>
54
55
56
57
58
59
#if defined(HAVE_USBHID_H)
#include <usbhid.h>
#elif defined(HAVE_LIBUSB_H)
#include <libusb.h>
#elif defined(HAVE_LIBUSBHID_H)
#include <libusbhid.h>
62
#if defined(__FREEBSD__) || defined(__FreeBSD_kernel__)
64
#include <osreldate.h>
66
67
68
#if __FreeBSD_kernel_version > 800063
#include <dev/usb/usb_ioctl.h>
#endif
69
70
71
#include <sys/joystick.h>
#endif
73
#include <machine/joystick.h>
76
#include "SDL_joystick.h"
77
78
#include "../SDL_sysjoystick.h"
#include "../SDL_joystick_c.h"
79
80
81
82
83
84
#define MAX_UHID_JOYS 4
#define MAX_JOY_JOYS 2
#define MAX_JOYS (MAX_UHID_JOYS + MAX_JOY_JOYS)
struct report {
85
86
87
#if defined(__FREEBSD__) && (__FreeBSD_kernel_version > 800063)
struct usb_gen_descriptor *buf; /* Buffer */
#else
88
struct usb_ctl_report *buf; /* Buffer */
90
91
92
93
94
95
96
97
98
99
100
size_t size; /* Buffer size */
int rid; /* Report ID */
enum {
SREPORT_UNINIT,
SREPORT_CLEAN,
SREPORT_DIRTY
} status;
};
static struct {
int uhid_report;
101
hid_kind_t kind;
102
103
104
105
106
107
const char *name;
} const repinfo[] = {
{ UHID_INPUT_REPORT, hid_input, "input" },
{ UHID_OUTPUT_REPORT, hid_output, "output" },
{ UHID_FEATURE_REPORT, hid_feature, "feature" }
};
108
109
110
111
112
113
114
115
116
117
118
119
enum {
REPORT_INPUT = 0,
REPORT_OUTPUT = 1,
REPORT_FEATURE = 2
};
enum {
JOYAXE_X,
JOYAXE_Y,
JOYAXE_Z,
JOYAXE_SLIDER,
120
121
122
123
124
JOYAXE_WHEEL,
JOYAXE_RX,
JOYAXE_RY,
JOYAXE_RZ,
JOYAXE_count
126
127
128
129
130
131
132
133
134
135
struct joystick_hwdata {
int fd;
char *path;
enum {
BSDJOY_UHID, /* uhid(4) */
BSDJOY_JOY /* joy(4) */
} type;
struct report_desc *repdesc;
struct report inreport;
136
int axis_map[JOYAXE_count]; /* map present JOYAXE_* to 0,1,..*/
137
138
139
140
141
142
int x;
int y;
int xmin;
int ymin;
int xmax;
int ymax;
143
144
145
146
147
148
149
150
};
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 *);
151
#if defined(USBHID_UCR_DATA) || defined(__FreeBSD_kernel__)
152
#define REP_BUF_DATA(rep) ((rep)->buf->ucr_data)
153
154
#elif (defined(__FREEBSD__) && (__FreeBSD_kernel_version > 800063))
#define REP_BUF_DATA(rep) ((rep)->buf->ugd_data)
155
156
157
158
#else
#define REP_BUF_DATA(rep) ((rep)->buf->data)
#endif
159
160
161
int
SDL_SYS_JoystickInit(void)
{
163
164
165
166
int i, fd;
SDL_numjoysticks = 0;
167
168
SDL_memset(joynames, 0, sizeof(joynames));
SDL_memset(joydevnames, 0, sizeof(joydevnames));
169
170
for (i = 0; i < MAX_UHID_JOYS; i++) {
171
172
SDL_Joystick nj;
173
SDL_snprintf(s, SDL_arraysize(s), "/dev/uhid%d", i);
174
175
176
177
178
179
180
181
nj.index = SDL_numjoysticks;
joynames[nj.index] = strdup(s);
if (SDL_SYS_JoystickOpen(&nj) == 0) {
SDL_SYS_JoystickClose(&nj);
SDL_numjoysticks++;
} else {
182
SDL_free(joynames[nj.index]);
183
joynames[nj.index] = NULL;
184
185
186
}
}
for (i = 0; i < MAX_JOY_JOYS; i++) {
187
SDL_snprintf(s, SDL_arraysize(s), "/dev/joy%d", i);
188
189
fd = open(s, O_RDONLY);
if (fd != -1) {
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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]);
}
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
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;
}
253
254
255
256
257
258
259
260
261
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;
264
fd = open(path, O_RDONLY);
265
if (fd == -1) {
266
267
268
269
SDL_SetError("%s: %s", path, strerror(errno));
return (-1);
}
270
hw = (struct joystick_hwdata *)SDL_malloc(sizeof(struct joystick_hwdata));
271
272
273
274
275
276
277
278
if (hw == NULL) {
SDL_OutOfMemory();
close(fd);
return (-1);
}
joy->hwdata = hw;
hw->fd = fd;
hw->path = strdup(path);
279
280
281
282
283
284
hw->x = 0;
hw->y = 0;
hw->xmin = 0xffff;
hw->ymin = 0xffff;
hw->xmax = 0;
hw->ymax = 0;
285
if (! SDL_strncmp(path, "/dev/joy", 8)) {
286
287
288
289
290
291
292
293
294
295
296
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;
}
297
298
299
300
301
{
int ax;
for (ax = 0; ax < JOYAXE_count; ax++)
hw->axis_map[ax] = -1;
}
302
303
304
305
306
307
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;
}
308
rep = &hw->inreport;
309
#if defined(__FREEBSD__) && (__FreeBSD_kernel_version > 800063) || defined(__FreeBSD_kernel__)
310
311
312
rep->rid = hid_get_report_id(fd);
if (rep->rid < 0) {
#else
313
if (ioctl(fd, USB_GET_REPORT_ID, &rep->rid) < 0) {
315
316
rep->rid = -1; /* XXX */
}
317
318
319
320
if (report_alloc(rep, hw->repdesc, REPORT_INPUT) < 0) {
goto usberr;
}
if (rep->size <= 0) {
321
322
SDL_SetError("%s: Input report descriptor has invalid length",
hw->path);
323
324
325
goto usberr;
}
326
#if defined(USBHID_NEW) || (defined(__FREEBSD__) && __FreeBSD_kernel_version >= 500111) || defined(__FreeBSD_kernel__)
327
328
hdata = hid_start_parse(hw->repdesc, 1 << hid_input, rep->rid);
#else
329
hdata = hid_start_parse(hw->repdesc, 1 << hid_input);
331
332
333
334
335
336
337
338
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;
341
342
while (hid_get_item(hdata, &hitem) > 0) {
343
344
char *sp;
const char *s;
345
346
347
348
349
350
351
352
353
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);
354
sp = SDL_malloc(SDL_strlen(s) + 5);
355
SDL_snprintf(sp, SDL_strlen(s) + 5, "%s (%d)", s,
356
357
358
359
360
361
362
joy->index);
joydevnames[joy->index] = sp;
}
}
break;
case hid_input:
switch (HID_PAGE(hitem.usage)) {
363
364
365
366
case HUP_GENERIC_DESKTOP: {
unsigned usage = HID_USAGE(hitem.usage);
int joyaxe = usage_to_joyaxe(usage);
if (joyaxe >= 0) {
368
369
370
371
372
} else if (usage == HUG_HAT_SWITCH) {
joy->nhats++;
}
break;
}
373
374
375
case HUP_BUTTON:
joy->nbuttons++;
break;
376
377
default:
break;
378
379
380
381
382
383
384
}
break;
default:
break;
}
}
hid_end_parse(hdata);
385
386
387
for (i=0; i<JOYAXE_count; i++)
if (hw->axis_map[i] > 0)
hw->axis_map[i] = joy->naxes++;
390
391
392
393
394
395
/* The poll blocks the event thread. */
fcntl(fd, F_SETFL, O_NONBLOCK);
return (0);
usberr:
close(hw->fd);
396
397
SDL_free(hw->path);
SDL_free(hw);
398
399
400
401
402
403
return (-1);
}
void
SDL_SYS_JoystickUpdate(SDL_Joystick *joy)
{
404
405
406
struct hid_item hitem;
struct hid_data *hdata;
struct report *rep;
407
int nbutton, naxe = -1;
410
#if defined(__FREEBSD__) || SDL_JOYSTICK_USBHID_MACHINE_JOYSTICK_H || defined(__FreeBSD_kernel__)
411
412
413
414
415
struct joystick gameport;
if (joy->hwdata->type == BSDJOY_JOY) {
if (read(joy->hwdata->fd, &gameport, sizeof gameport) != sizeof gameport)
return;
416
417
418
419
if (abs(joy->hwdata->x - gameport.x) > 8) {
joy->hwdata->x = gameport.x;
if (joy->hwdata->x < joy->hwdata->xmin) {
joy->hwdata->xmin = joy->hwdata->x;
421
422
if (joy->hwdata->x > joy->hwdata->xmax) {
joy->hwdata->xmax = joy->hwdata->x;
424
425
426
if (joy->hwdata->xmin == joy->hwdata->xmax) {
joy->hwdata->xmin--;
joy->hwdata->xmax++;
428
429
430
v = (Sint32)joy->hwdata->x;
v -= (joy->hwdata->xmax + joy->hwdata->xmin + 1)/2;
v *= 32768/((joy->hwdata->xmax - joy->hwdata->xmin + 1)/2);
431
432
SDL_PrivateJoystickAxis(joy, 0, v);
}
433
434
435
436
if (abs(joy->hwdata->y - gameport.y) > 8) {
joy->hwdata->y = gameport.y;
if (joy->hwdata->y < joy->hwdata->ymin) {
joy->hwdata->ymin = joy->hwdata->y;
438
439
if (joy->hwdata->y > joy->hwdata->ymax) {
joy->hwdata->ymax = joy->hwdata->y;
441
442
443
if (joy->hwdata->ymin == joy->hwdata->ymax) {
joy->hwdata->ymin--;
joy->hwdata->ymax++;
445
446
447
v = (Sint32)joy->hwdata->y;
v -= (joy->hwdata->ymax + joy->hwdata->ymin + 1)/2;
v *= 32768/((joy->hwdata->ymax - joy->hwdata->ymin + 1)/2);
448
449
450
451
452
453
454
455
456
457
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;
}
459
460
rep = &joy->hwdata->inreport;
461
462
if (read(joy->hwdata->fd, REP_BUF_DATA(rep), rep->size) != rep->size) {
463
464
return;
}
465
#if defined(USBHID_NEW) || (defined(__FREEBSD__) && __FreeBSD_kernel_version >= 500111) || defined(__FreeBSD_kernel__)
466
467
hdata = hid_start_parse(joy->hwdata->repdesc, 1 << hid_input, rep->rid);
#else
468
hdata = hid_start_parse(joy->hwdata->repdesc, 1 << hid_input);
470
471
472
473
474
475
if (hdata == NULL) {
fprintf(stderr, "%s: Cannot start HID parser\n",
joy->hwdata->path);
return;
}
476
for (nbutton = 0; hid_get_item(hdata, &hitem) > 0;) {
477
478
479
switch (hitem.kind) {
case hid_input:
switch (HID_PAGE(hitem.usage)) {
480
481
482
483
484
485
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 */
486
v = (Sint32)hid_get_data(REP_BUF_DATA(rep),
487
&hitem);
488
489
v -= (hitem.logical_maximum + hitem.logical_minimum + 1)/2;
v *= 32768/((hitem.logical_maximum - hitem.logical_minimum + 1)/2);
490
if (v != joy->axes[naxe]) {
491
SDL_PrivateJoystickAxis(joy, naxe, v);
493
494
495
} else if (usage == HUG_HAT_SWITCH) {
v = (Sint32)hid_get_data(REP_BUF_DATA(rep),
&hitem);
498
499
500
}
break;
}
501
case HUP_BUTTON:
502
v = (Sint32)hid_get_data(REP_BUF_DATA(rep),
504
505
506
507
508
509
if (joy->buttons[nbutton] != v) {
SDL_PrivateJoystickButton(joy,
nbutton, v);
}
nbutton++;
break;
510
511
default:
continue;
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
}
break;
default:
break;
}
}
hid_end_parse(hdata);
return;
}
/* Function to close a joystick after use */
void
SDL_SYS_JoystickClose(SDL_Joystick *joy)
{
527
if (SDL_strncmp(joy->hwdata->path, "/dev/joy", 8)) {
528
529
530
report_free(&joy->hwdata->inreport);
hid_dispose_report_desc(joy->hwdata->repdesc);
}
531
close(joy->hwdata->fd);
532
533
SDL_free(joy->hwdata->path);
SDL_free(joy->hwdata);
534
535
536
537
538
539
540
541
542
543
544
return;
}
void
SDL_SYS_JoystickQuit(void)
{
int i;
for (i = 0; i < MAX_JOYS; i++) {
if (joynames[i] != NULL)
545
SDL_free(joynames[i]);
546
if (joydevnames[i] != NULL)
547
SDL_free(joydevnames[i]);
548
549
550
551
552
553
554
555
556
557
}
return;
}
static int
report_alloc(struct report *r, struct report_desc *rd, int repind)
{
int len;
558
559
560
#ifdef __DragonFly__
len = hid_report_size(rd, r->rid, repinfo[repind].kind);
#elif __FREEBSD__
561
562
# if (__FreeBSD_kernel_version >= 460000) || defined(__FreeBSD_kernel__)
# if (__FreeBSD_kernel_version <= 500111)
563
len = hid_report_size(rd, r->rid, repinfo[repind].kind);
564
565
566
# else
len = hid_report_size(rd, repinfo[repind].kind, r->rid);
# endif
567
568
# else
len = hid_report_size(rd, repinfo[repind].kind, &r->rid);
571
572
# ifdef USBHID_NEW
len = hid_report_size(rd, repinfo[repind].kind, r->rid);
575
# endif
578
579
580
581
582
583
584
if (len < 0) {
SDL_SetError("Negative HID report size");
return (-1);
}
r->size = len;
if (r->size > 0) {
585
r->buf = SDL_malloc(sizeof(*r->buf) - sizeof(REP_BUF_DATA(r)) +
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
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) {
603
SDL_free(r->buf);
604
605
606
607
}
r->status = SREPORT_UNINIT;
}
608
#endif /* SDL_JOYSTICK_USBHID */