-
Notifications
You must be signed in to change notification settings - Fork 124
/
Copy pathretrogame.c
1223 lines (1122 loc) · 43.5 KB
/
retrogame.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
ADAFRUIT RETROGAME UTILITY: remaps buttons on Raspberry Pi GPIO header to
virtual USB keyboard presses. Great for classic game emulators! Retrogame
is interrupt-driven and efficient (typically < 0.3% CPU use, even w/heavy
button-mashing) and debounces inputs for glitch-free gaming.
****** IF YOU ARE SEARCHING FOR THE ioStandard[] OR ioTFT[] TABLES: ******
GPIO pin and key mapping is now set in a configuration file; there's no
fixed table to edit in this code (as in earlier releases). An example
config file is provided in retrogame.cfg. By default, retrogame looks for
this file in /boot, but an alternate (full pathname) can be passed as a
command line argument.
Connect one side of button(s) to GND pin (there are several on the GPIO
header, but see later notes) and the other side to GPIO pin of interest.
Internal pullups are used; no resistors required. MCP23017 I2C port
expanders are also supported (up to 8). Pin mapping is:
0 - 31 GPIO header 'P5' (Broadcom pin numbers)
32 - 47 MCP23017 at address 0x20
48 - 63 MCP23017 at address 0x21
64 - 79 MCP23017 at address 0x22
80 - 95 MCP23017 at address 0x23
96 - 111 MCP23017 at address 0x24
112 - 127 MCP23017 at address 0x25
128 - 143 MCP23017 at address 0x26 *** Arcade Bonnet default address
144 - 159 MCP23017 at address 0x27 *** Arcade Bonnet alt address
Config file IRQ command must be used to bind a GPIO pin to an I2C address!
Must be run as root, i.e. 'sudo ./retrogame &' or edit /etc/rc.local to
launch automatically at system startup.
Early Raspberry Pi Linux distributions might not have the uinput kernel
module installed by default. To enable this, add a line to /etc/modules:
uinput
This code has bloated into a stinking seven-headed hydra.
Please no more feature creep.
Written by Phil Burgess for Adafruit Industries, distributed under BSD
License. Adafruit invests time and resources providing this open source
code, please support Adafruit and open-source hardware by purchasing
products from Adafruit!
Copyright (c) 2013, 2016 Adafruit Industries.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <ctype.h>
#include <stdbool.h>
#include <fcntl.h>
#include <poll.h>
#include <signal.h>
#include <dirent.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <sys/signalfd.h>
#include <sys/inotify.h>
#include <linux/input.h>
#include <linux/uinput.h>
#include <linux/i2c-dev.h>
#include <bcm_host.h>
#include "keyTable.h"
// Global variables and such -----------------------------------------------
bool
running = true, // Signal handler will set false (exit)
isEarlyPi = false; // true=Pi1Rev1, false=all other
extern char
*__progname, // Program name (for error reporting)
*program_invocation_name; // Full name as invoked (path, etc.)
char
sysfs_root[] = "/sys/class/gpio", // Location of Sysfs GPIO files
*cfgPath, // Directory containing config file
*cfgName = NULL, // Name (no path) of config
*cfgPathname, // Full path/name to config file
debug = 0, // 0=off, 1=cfg file, 2=live buttons
startupDebug = 0, // Initial debug level before cfg load
readAddr = 0x10; // For MCP23017 reads (INTCAPA reg addr)
int
key[161], // Keycodes assigned to GPIO pins
fileWatch, // inotify file descriptor
keyfd1 = -1, // /dev/uinput file descriptor
keyfd2 = -1, // /dev/input/eventX file descriptor
keyfd = -1, // = (keyfd2 >= 0) ? keyfd2 : keyfd1;
i2cfd[8], // /dev/i2c-1 MCP23017 file descriptors
vulcanTime = 1500, // Pinch time in milliseconds
debounceTime = 20, // 20 ms for button debouncing
repTime1 = 500, // Key hold time to begin repeat
repTime2 = 100; // Time between key repetitions
// Note: auto-repeat is for navigating the game-selection menu using the
// 'gamera' utility; MAME disregards key repeat events (as it should).
uint32_t
intstate[5], // Button last-read state (bitmask)
extstate[5], // Button debounced state
vulcanMask[5], // Bitmask of 'Vulcan nerve pinch' keys
mcpMask = 0; // Bitmask of GPIOs assigned to MCP IRQs
uint8_t
mcpI2C[32]; // GPIO index to MCP23017 I2C addr
volatile unsigned int
*gpio = NULL; // GPIO register table
struct pollfd
p[35]; // File descriptors for poll()
enum commandNum {
CMD_NONE, // Used during config file read (no command ID'd yet)
CMD_KEY, // Key-to-GPIO mapping command
CMD_IRQ, // MCP23017 IRQ pin & address assignment
CMD_GND, // Pin-to-ground assignment
CMD_DEBUG // Set debug level
};
// dict of config file commands that AREN'T keys (KEY_*)
dict command[] = { // Struct is defined in keyTable.h
{ "GND" , CMD_GND },
{ "GROUND" , CMD_GND },
{ "IRQ" , CMD_IRQ },
{ "DEBUG" , CMD_DEBUG },
// Might add commands here for fine-tuning debounce & repeat settings
{ NULL , -1 } }; // END-OF-LIST
#define GPIO_BASE 0x200000
#define BLOCK_SIZE (4*1024)
#define GPPUD (0x94 / 4)
#define GPPUDCLK0 (0x98 / 4)
#define PULLUPDN_OFFSET_2711_0 57
#define PULLUPDN_OFFSET_2711_1 58
#define PULLUPDN_OFFSET_2711_2 59
#define PULLUPDN_OFFSET_2711_3 60
#define IODIRA 0x00
#define IOCONA 0x0A
#define GND KEY_CNT
// Debug levels: 0 = off, 1 = config file errors, 2 = + config file status,
// 3 = + report button states 'live'.
// Some utility functions --------------------------------------------------
// Detect Pi board type. Not detailed, just enough for GPIO compatibilty:
// true = Pi 1 Model B revision 1 (some GPIO pin numbers were different)
// false = All other board types
static bool earlyPiDetect(void) {
FILE *fp;
char buf[1024], *ptr;
int n;
bool isEarly = false; // Assume "modern" Pi by default
// Relies on info in /proc/cmdline. If this becomes unreliable
// in the future, alt code below uses /proc/cpuinfo if any better.
#if 1
if((fp = fopen("/proc/cmdline", "r"))) {
while(fgets(buf, sizeof(buf), fp)) {
if((ptr = strstr(buf, "boardrev=")) &&
(sscanf(&ptr[9], "%x", &n) == 1) &&
((n == 0x02) || (n == 0x03))) {
isEarly = true; // Appears to be an early Pi
break;
}
}
fclose(fp);
}
#else
char s[8];
if((fp = fopen("/proc/cpuinfo", "r"))) {
while(fgets(buf, sizeof(buf), fp)) {
if((ptr = strstr(buf, "Revision")) &&
(sscanf(&ptr[8], " : %x", &n) == 1) &&
((n == 0x02) || (n == 0x03))) {
isEarly = true; // Appears to be an early Pi
break;
}
}
fclose(fp);
}
#endif
return isEarly;
}
// Set one GPIO pin attribute through the Sysfs interface.
static int pinSetup(int pin, char *attr, char *value) {
char filename[50];
int fd, w, len = strlen(value);
sprintf(filename, "%s/gpio%d/%s", sysfs_root, pin, attr);
if((fd = open(filename, O_WRONLY)) < 0) return -1;
w = write(fd, value, len);
close(fd);
return (w != len); // 0 = success
}
// Configure GPIO internal pull up/down/none
static void pull(int bitmask, int state) {
if(gpio[PULLUPDN_OFFSET_2711_3] != 0x6770696f) {
// Pi 4 insights from RPi.GPIO:
unsigned int pull = state ? (3 - state) : state;
for(int bit=0; bit<32; bit++) {
if(!(bitmask & (1UL << bit))) continue;
int pullreg = PULLUPDN_OFFSET_2711_0 + (bit >> 4);
int pullshift = (bit & 0xF) << 1;
unsigned int pullbits;
pullbits = gpio[pullreg];
pullbits &= ~(3 << pullshift);
pullbits |= (pull << pullshift);
gpio[pullreg] = pullbits;
}
} else {
// Legacy pull up/down method:
volatile unsigned char shortWait;
gpio[GPPUD] = state; // 2=up, 1=down, 0=none
for(shortWait=150;--shortWait;); // Min 150 cycle wait
gpio[GPPUDCLK0] = bitmask; // Set pullup mask
for(shortWait=150;--shortWait;); // Wait again
gpio[GPPUD] = 0; // Reset pullup registers
gpio[GPPUDCLK0] = 0;
}
}
// Restore GPIO and uinput to startup state; un-export any Sysfs pins used,
// don't leave any filesystem cruft; restore any GND pins to inputs and
// disable previously-set pull-ups. Write errors are ignored as pins may be
// in a partially-initialized state.
static void pinConfigUnload() {
char buf[50];
int fd, i;
if(debug >= 2) printf("%s: Unloading config\n", __progname);
// Close GPIO file descriptors
for(i=0; i<32; i++) {
if(p[i].fd >= 0) {
close(p[i].fd);
p[i].fd = -1;
}
p[i].events = p[i].revents = 0;
}
// Close uinput file descriptors
keyfd = -1;
if(keyfd2 >= 0) {
close(keyfd2);
keyfd2 = -1;
}
if(keyfd1 >= 0) {
ioctl(keyfd1, UI_DEV_DESTROY);
close(keyfd1);
keyfd1 = -1;
}
// Un-export GPIO pins (0-31)
sprintf(buf, "%s/unexport", sysfs_root);
if((fd = open(buf, O_WRONLY)) >= 0) {
for(i=0; i<32; i++) {
// Restore GND items to inputs
if(key[i] >= GND) pinSetup(i, "direction", "in");
// And un-export all items regardless
sprintf(buf, "%d", i);
write(fd, buf, strlen(buf));
}
close(fd);
}
// Disable GPIO pullups (0-31)
uint32_t mask = vulcanMask[0] | mcpMask;
for(i=0; i<32; i++) {
if((key[i] > KEY_RESERVED) && (key[i] < GND))
mask |= (1 << i);
}
pull(mask, 0); // Disable pullups
// Do some GPIO dis-configuration for any MCO23017(s).
// GNDs are set back to inputs; other config (pullups, etc.)
// are currently left in whatever state.
for(i=0; i<8; i++) {
if(i2cfd[i] > 0) {
// Determine which bits were previously set GND
uint8_t j;
uint16_t gndMask = 0;
for(j=0; j<16; j++) { // 16 bits per MCP
if(key[32 + i * 16 + j] == GND)
gndMask |= (1 << j);
}
// Read chip config
uint8_t cfg[3];
cfg[0] = IODIRA;
write(i2cfd[i], cfg, 1);
read(i2cfd[i], &cfg[1], sizeof(cfg) - 1);
// Change IODIRA,B GND bits back to inputs
cfg[1] = (cfg[1] | gndMask );
cfg[2] = (cfg[2] | (gndMask >> 8));
// Write to chip, close device
write(i2cfd[i], cfg, sizeof(cfg));
close(i2cfd[i]);
i2cfd[i] = 0;
}
}
// Reset pin-and-key-related globals
for(i=0; i<161; i++) key[i] = KEY_RESERVED;
memset(intstate , 0, sizeof(intstate));
memset(extstate , 0, sizeof(extstate));
memset(vulcanMask, 0, sizeof(vulcanMask));
memset(mcpI2C , 0, sizeof(mcpI2C));
memset(i2cfd , 0, sizeof(i2cfd));
mcpMask = 0;
}
// Quick-n-dirty error reporter; print message, clean up and exit.
static void err(char *msg) {
printf("%s: %s. Try 'sudo %s' ?\n", __progname, msg,
program_invocation_name);
if(gpio) pinConfigUnload();
exit(1);
}
// Filter function for scandir(), identifies possible device candidates for
// simulated keypress events (distinct from actual USB keyboard(s)).
static int filter1(const struct dirent *d) {
if(!strncmp(d->d_name, "input", 5)) { // Name usu. 'input' + #
// Read contents of 'name' file inside this subdirectory,
// if it matches the retrogame executable, that's probably
// the device we want...
char filename[100], line[100];
FILE *fp;
sprintf(filename, "/sys/devices/virtual/input/%s/name",
d->d_name);
memset(line, 0, sizeof(line));
if((fp = fopen(filename, "r"))) {
fgets(line, sizeof(line), fp);
fclose(fp);
}
if(!strncmp(line, __progname, strlen(__progname))) return 1;
}
return 0;
}
// A second scandir() filter, checks for filename of 'event' + #
static int filter2(const struct dirent *d) {
return !strncmp(d->d_name, "event", 5);
}
// Search for name in dictionary, return assigned value (-1 = not found)
static int dictSearch(char *str, dict *d) {
int i;
for(i=0; d[i].name && strcasecmp(str, d[i].name); i++);
return d[i].value;
}
// If this is a "Revision 1" Pi board (no mounting holes), remap certain
// pin numbers for compatibility. Can then use 'modern' pin numbers
// regardless of board type.
static int pinRemap(int i) {
if(isEarlyPi) {
if (i == 2) return 0;
else if(i == 3) return 1;
else if(i == 27) return 21;
}
return i;
}
// Config file handlage ----------------------------------------------------
// Load pin/key configuration from cfgPathname.
static void pinConfigLoad() {
// Config file format is super simple, just per-line keyword and
// argument(s) with whitespace delimiters...can parse it ourselves
// here. Configuration libraries such as libconfig, libconfuse
// have some potent features but enforce a correspondingly more
// exacting syntax on the user; do not want if we can avoid it.
FILE *fp;
char buf[50];
enum commandNum cmd = CMD_NONE;
int stringLen = 0,
wordCount = 0,
keyCode = KEY_RESERVED,
i, c, k, fd, bitmask, dLevel = -1,
mcpPin = -1, mcpAddr = -1;
bool readingString = false,
isComment = false;
uint32_t pinMask[5];
if(debug >= 2) printf("%s: Loading config\n", __progname);
// Read config file into key[] table -------------------------------
if(NULL == (fp = fopen(cfgPathname, "r"))) {
if(debug >= 1) printf("%s: could not open config file '%s' "
"(not fatal, continuing)\n", __progname, cfgPathname);
return; // Not fatal; file might be created later
}
do { // Deep nesting, please excuse shift to two-space indents...
c = getc(fp);
if(isspace(c) || (c <= 0)) { // If whitespace char...
if(readingString && !isComment) {
// Switching from string-reading to whitespace-skipping.
// Cap off & process current string, reset readingString flag.
buf[stringLen] = 0;
if(wordCount == 1) {
// First word on line. Search key dict, then command dict
memset(pinMask, 0, sizeof(pinMask));
keyCode = KEY_RESERVED;
if((k = dictSearch(buf, keyTable)) >= 0) {
// Start of key command
cmd = CMD_KEY;
keyCode = k;
} else if((k = dictSearch(buf, command)) >= 0) {
// Not a key, is other command (e.g. GND, DEBUG)
cmd = k;
} else if(debug >= 1) {
printf("%s: unknown key or command '%s' (not fatal, "
"continuing)\n", __progname, buf);
}
} else {
// Word #2+ on line; Certain commands may accumulate
// values (e.g. keys w/pinch).
char *endptr;
int arg = strtol(buf, &endptr, 0);
switch(cmd) {
case CMD_KEY:
case CMD_GND:
if((*endptr) || (arg < 0) || (arg > 159)) {
// Non-NUL character indicates not full string
// was parsed, i.e. bad numeric input.
if(debug >= 1) {
printf("%s: invalid pin '%s' (not fatal, "
"continuing)\n", __progname, buf);
}
} else {
// Add pin # (in 'arg') to list
arg = pinRemap(arg); // Handle early Pi boards
pinMask[arg/32] |= (1 << (arg&31));
}
break;
case CMD_IRQ:
switch(wordCount) {
case 2: // word 2 = GPIO pin number for IRQ, MUST be 0-31
if((*endptr) || (arg < 0) || (arg > 31)) {
if(debug >= 1) {
printf("%s: invalid pin '%s' (not fatal, "
"continuing)\n", __progname, buf);
}
} else {
mcpPin = pinRemap(arg); // Handle early Pi boards
}
break;
case 3: // word 3 = I2C addr, must be 0-7 or 0x20-0x27
if((*endptr) || (arg < 0) || (arg > 0x27) ||
((arg > 7) && (arg < 0x20))) {
if(debug >= 1) {
printf("%s: invalid I2C address '%s' (not fatal, "
"continuing)\n", __progname, buf);
}
} else {
mcpAddr = (arg < 0x20) ? (arg + 0x20) : arg;
}
break;
default:
if(debug >= 1) {
printf("%s: extraneous parameter '%s' (not fatal, "
"continuing)\n", __progname, buf);
}
break;
}
break;
case CMD_DEBUG:
if((*endptr) || (arg < 0) || (arg > 3)) {
if(debug >= 1) {
printf("%s: invalid debug level '%s' "
"(not fatal, continuing)\n", __progname, buf);
}
} else {
dLevel = arg;
}
break;
default:
break;
}
}
readingString = false;
}
if((c == '\n') || (c <= 0)) { // If EOF or EOL
// Execute last line if useful command
switch(cmd) {
case CMD_KEY:
// Count number of pins on line (k)
for(k=i=0; i<160; i++) {
if(pinMask[i/32] & (1 << (i&31))) {
k++;
// Un-assign any pins previously assigned GND.
if(key[i] == GND) key[i] = KEY_RESERVED;
}
}
if(k == 1) { // Key assigned to one pin
for(i=0; !(pinMask[i/32] & (1<<(i&31))); i++); // Find bit
key[i] = keyCode;
if(debug >= 2) {
printf("%s: virtual key %d assigned to GPIO%02d\n",
__progname, keyCode, i);
}
} else if(k > 1) {
memcpy(vulcanMask, pinMask, sizeof(pinMask));
key[160] = keyCode;
if(debug >= 2) {
printf("%s: virtual key %d has GPIO bitmask "
"%04X%04X%04X%04X%04X\n", __progname, key[160],
vulcanMask[4], vulcanMask[3], vulcanMask[2],
vulcanMask[1], vulcanMask[0]);
}
}
break;
case CMD_IRQ:
if((mcpPin >= 0) && (mcpAddr >= 0)) { // Got all params?
if(debug >= 2) {
printf("%s: MCP23017 on GPIO%02d, I2C address 0x%02X\n",
__progname, mcpPin, mcpAddr);
}
mcpI2C[mcpPin] = mcpAddr; // GPIO pin # to I2C address
mcpMask |= (1 << mcpPin);
mcpPin = mcpAddr = -1;
}
break;
case CMD_GND:
// One or more GND pins
for(i=0; i<160; i++) {
if(pinMask[i/32] & (1 << (i&31))) {
key[i] = GND;
if(debug >= 2) {
printf("%s: GPIO%02d assigned GND\n", __progname, i);
}
}
}
// Clear any vulcanMask bits that are now GNDs
for(i=k=0; i<5; i++) {
vulcanMask[i] &= ~pinMask[i];
if(vulcanMask[i]) k = 1;
}
if(!k) key[160] = KEY_RESERVED; // All vulcan bits clobbered
break;
case CMD_DEBUG:
if(debug || (dLevel > 0)) {
printf("%s: debug level %d\n", __progname, dLevel);
}
debug = dLevel;
break;
default:
break;
}
// Reset ALL string-reading flags
readingString = false;
stringLen = 0;
wordCount = 0;
isComment = false;
cmd = CMD_NONE;
}
} else { // Non-whitespace char
if(isComment) continue;
if(!readingString) {
// Switching from whitespace-skipping
// to string-reading. Reset string.
readingString = true;
stringLen = 0;
// Is it beginning of a comment?
// If so, ignore chars to next EOL.
if(c == '#') {
isComment = true;
continue;
}
wordCount++;
}
// Append characer to current string
if(stringLen < (sizeof(buf) - 1)) buf[stringLen++] = c;
}
} while(c > 0);
fclose(fp);
// If debug was previously set (either in file or by starting
// in foreground) but line is now deleted, set debug level to
// whatever its startup case was.
if(debug && (dLevel < 0)) {
debug = startupDebug;
printf("%s: debug level %d\n", __progname, debug);
}
// Set up GPIO -----------------------------------------------------
bitmask = vulcanMask[0] | mcpMask;
for(i=0; i<32; i++) {
if((key[i] > KEY_RESERVED) && (key[i] < GND))
bitmask |= (1 << i);
}
pull(bitmask, 2); // Enable pullups on input pins
for(i=0; (i<5) && !vulcanMask[i]; i++); // If no vulcanMask bits,
if(i >= 5) key[160] = KEY_RESERVED; // make sure no vulcanKey
// Pullups on MCP23017 devices will be a separate pass later
// All other GPIO config is handled through the sysfs interface.
sprintf(buf, "%s/export", sysfs_root);
if((fd = open(buf, O_WRONLY)) < 0) // Open Sysfs export file
err("Can't open GPIO export file");
intstate[0] = 0;
for(i=0; i<32; i++) {
if((key[i] == KEY_RESERVED) && !(bitmask & (1<<i)))
continue;
sprintf(buf, "%d", i);
write(fd, buf, strlen(buf)); // Export pin
pinSetup(i, "active_low", "0"); // Don't invert
if(key[i] >= GND) {
// Set pin to output, value 0 (ground)
if(pinSetup(i, "direction", "out") ||
pinSetup(i, "value" , "0"))
err("Pin config failed (GND)");
} else {
// Set pin to input, detect edge events
char x;
// Plain GPIOs: detect both RISING and FALLING
// edges. Port expanders: detect FALLING only.
if(pinSetup(i, "direction", "in") ||
pinSetup(i, "edge",
(mcpMask & (1<<i)) ? "falling" : "both")) {
err("Pin config failed");
}
// Get initial pin value. This is for plain GPIOs
// only; MCP23017 will be a separate pass later.
sprintf(buf, "%s/gpio%d/value", sysfs_root, i);
if((p[i].fd = open(buf, O_RDONLY | O_NONBLOCK)) < 0)
err("Can't access pin value");
if((read(p[i].fd, &x, 1) == 1) && (x == '0'))
intstate[0] |= 1 << i;
p[i].events = POLLPRI | POLLERR | POLLHUP | POLLNVAL;
p[i].revents = 0;
}
}
close(fd); // Done w/Sysfs exporting
// Set up uinput
// Attempt to create uidev virtual keyboard
if((keyfd1 = open("/dev/uinput", O_WRONLY | O_NONBLOCK)) >= 0) {
(void)ioctl(keyfd1, UI_SET_EVBIT, EV_KEY);
for(i=0; i<161; i++) {
if((key[i] >= KEY_RESERVED) && (key[i] < GND))
(void)ioctl(keyfd1, UI_SET_KEYBIT, key[i]);
}
struct uinput_user_dev uidev;
memset(&uidev, 0, sizeof(uidev));
snprintf(uidev.name, UINPUT_MAX_NAME_SIZE, "retrogame");
uidev.id.bustype = BUS_USB;
uidev.id.vendor = 0x1;
uidev.id.product = 0x1;
uidev.id.version = 1;
if(write(keyfd1, &uidev, sizeof(uidev)) < 0)
err("write failed");
if(ioctl(keyfd1, UI_DEV_CREATE) < 0)
err("DEV_CREATE failed");
if(debug >= 3) printf("%s: uidev init OK\n", __progname);
}
// SDL2 (used by some newer emulators) wants /dev/input/eventX
// instead -- BUT -- this only exists if there's a physical USB
// keyboard attached or if the above code has run and created a
// virtual keyboard. On older systems this method doesn't apply,
// events can be sent to the keyfd1 virtual keyboard above...so,
// this code looks for an eventX device and (if present) will use
// that as the destination for events, else fallback on keyfd1.
// The 'X' in eventX is a unique identifier (typically a numeric
// digit or two) for each input device, dynamically assigned as
// USB input devices are plugged in or disconnected (or when the
// above code runs, creating a virtual keyboard). As it's
// dynamically assigned, we can't rely on a fixed number -- it
// will vary if there's a keyboard connected at startup.
struct dirent **namelist;
int n;
char evName[100] = "";
if((n = scandir("/sys/devices/virtual/input",
&namelist, filter1, NULL)) > 0) {
// Got a list of device(s). In theory there should
// be only one that makes it through the filter (name
// matches retrogame)...if there's multiples, only
// the first is used. (namelist can then be freed)
char path[100];
sprintf(path, "/sys/devices/virtual/input/%s",
namelist[0]->d_name);
for(i=0; i<n; i++) free(namelist[i]);
free(namelist);
// Within the given device path should be a subpath with
// the name 'eventX' (X varies), again theoretically
// should be only one, first in list is used.
if((n = scandir(path, &namelist, filter2, NULL)) > 0) {
sprintf(evName, "/dev/input/%s",
namelist[0]->d_name);
for(i=0; i<n; i++) free(namelist[i]);
free(namelist);
}
}
if(!evName[0]) { // Nothing found? Use fallback method...
// Kinda lazy skim for last item in /dev/input/event*
// This is NOT guaranteed to be retrogame, but if the
// above method fails for some reason, this may be
// adequate. If there's a USB keyboard attached at
// boot, it usually instantiates in /dev/input before
// retrogame, so even if it's then removed, the index
// assigned to retrogame stays put...thus the last
// index mmmmight be what we need.
struct stat st;
for(i=99; i>=0; i--) {
sprintf(buf, "/dev/input/event%d", i);
if(!stat(buf, &st)) break; // last valid device
}
strcpy(evName, (i >= 0) ? buf : "/dev/input/event0");
}
keyfd2 = open(evName, O_WRONLY | O_NONBLOCK);
keyfd = (keyfd2 >= 0) ? keyfd2 : keyfd1;
// keyfd1 and 2 are global and are held open (as a destination for
// key events) until pinConfigUnload() is called.
if((debug >= 3) && keyfd2) printf("%s: SDL2 init OK\n", __progname);
// Configure MCP23017 port expander(s)
uint8_t cfg1[] = { 0x05 , 0x00 }, // If bank 1, switch to 0
cfg2[] = { IOCONA, 0x44 }, // Bank 0, INTB=A, seq, OD IRQ
cfg3[23]; // Read-modify-write chip cfg
uint16_t inputMask, gndMask;
if(mcpMask) { // Any port expanders mentioned in config?
for(i=0; i<8; i++) { // 8 possible MCP23017 indices
uint8_t j;
inputMask = gndMask = 0; // Bitmasks of keys, gnds on this device
for(j=0; j<16; j++) { // 16 bits per MCP
k = key[32 + i * 16 + j];
if(k == GND) gndMask |= (1 << j);
else if(k > KEY_RESERVED) inputMask |= (1 << j);
}
if(inputMask || gndMask) { // Referenced in config?
// Each MCP23017 is assigned a separate file descriptor;
// each bonded once to a specific I2C address (via ioctl)
// so that the ioctl isn't required for every transaction.
if((i2cfd[i] = open("/dev/i2c-1", O_RDWR | O_NONBLOCK)) > 0) {
ioctl(i2cfd[i], I2C_SLAVE, 0x20 + i);
// Configure chip as we need it (sequential addr, etc.).
// This does mean any other application also using the
// chip might be clobbered if it uses a different config.
write(i2cfd[i], cfg1, sizeof(cfg1));
write(i2cfd[i], cfg2, sizeof(cfg2));
// Some bits are preserved as best we can...read
// registers, change bits for retrogame, write back.
// This is done in two passes; first one does some
// polarity stuff, second pass sets more and reads state.
cfg3[0] = IODIRA;
write(i2cfd[i], cfg3, 1);
read(i2cfd[i], &cfg3[1], 4); // Read partial config
// Change IODIRA,B bits for inputs & GNDs (leave others)
cfg3[1] = (cfg3[1] | inputMask ) & ~gndMask;
cfg3[2] = (cfg3[2] | (inputMask >> 8)) & ~(gndMask >> 8);
// Set IPOLA,B for inputs+GNDs (polarity matches input logic)
cfg3[3] &= ~( inputMask | gndMask);
cfg3[4] &= ~((inputMask | gndMask) >> 8);
write(i2cfd[i], cfg3, 5); // Write partial config
write(i2cfd[i], cfg3, 1); // Next read is from IODIRA
read(i2cfd[i], &cfg3[1], sizeof(cfg3) - 1); // Read full cfg
// Enable interrupts on input pins (GPINTENA,B)
cfg3[5] |= inputMask;
cfg3[6] |= inputMask >> 8;
// Skip DEFVALA,B
cfg3[9] = cfg3[10] = 0; // INTCONA,B: compre prev pin value
// Skip IOCON (x2)
// Set GPPUA,B bits on input pins
cfg3[13] |= inputMask;
cfg3[14] |= inputMask >> 8;
// Skip INTFA,B, INTCAPA,B, read GPIOA,B into int/extstate[]
int idx = 1 + i / 2; // Index (1-4) into int/extstate[]
uint8_t bit; // Bit to read in GPIOA/B
uint32_t abit, bbit; // Bit to set in int/ext state
if(i & 1) { // In upper half of int/ext state
abit = 0x00800000;
bbit = 0x80000000;
} else { // In lower half
abit = 0x00000080;
bbit = 0x00008000;
}
for(bit=0x80; bit; bit >>= 1, abit >>= 1, bbit >>= 1) {
// Invert logic; set bits in intstate[] are buttons
// pressed, while set bits in config are pulled up.
if(cfg3[19] & bit) intstate[idx] &= ~abit;
else intstate[idx] |= abit;
if(cfg3[20] & bit) intstate[idx] &= ~bbit;
else intstate[idx] |= bbit;
}
// Clear OLATA,B bits on GND outputs
cfg3[21] &= ~gndMask;
cfg3[22] &= ~(gndMask >> 8);
write(i2cfd[i], cfg3, sizeof(cfg3));
// Clear interrupt by reading GPIOA/B+INTCAPA/B
write(i2cfd[i], &readAddr, 1);
read(i2cfd[i], cfg3, 4);
}
}
}
}
memcpy(extstate, intstate, sizeof(extstate));
}
// Handle signal events (i=32), config file change events (33) or
// config directory contents change events (34).
static void pollHandler(int i) {
if(i == 32) { // Signal event
struct signalfd_siginfo info;
read(p[i].fd, &info, sizeof(info));
if(info.ssi_signo == SIGHUP) { // kill -1 = force reload
if(debug >= 2) {
printf("%s: SIGHUP received; force config "
"reload\n", __progname);
}
pinConfigUnload();
pinConfigLoad();
} else { // Other signal = abort program
running = false;
}
} else { // Change in config file or directory contents
char evBuf[1000];
//int evCount = 0;
int bufPos = 0,
bytesRead = read(p[i].fd, evBuf, sizeof(evBuf));
while(bufPos < bytesRead) {
struct inotify_event *ev =
(struct inotify_event *)&evBuf[bufPos];
//printf("EVENT %d:\n", evCount++);
//printf("\tinotify event mask: %08x\n", ev->mask);
//printf("\tlen: %d\n", ev->len);
//if(ev->len > 0)
//printf("\tname: '%s'\n", ev->name);
if(ev->mask & IN_MODIFY) {
if(debug >= 2) {
printf("%s: Config file changed\n",
__progname);
}
pinConfigUnload();
pinConfigLoad();
} else if(ev->mask & IN_IGNORED) {
// Config file deleted -- stop watching it
if(debug >= 2) {
printf("%s: Config file removed\n",
__progname);
}
inotify_rm_watch(p[1].fd, fileWatch);
// Closing the descriptor turns out to be
// important, as removing the watch itself
// creates another IN_IGNORED event.
// Avoids turtles all the way down.
close(p[33].fd);
p[33].fd = -1;
p[33].events = 0;
// Pin config is NOT unloaded...
// keep using prior values for now.
} else if(ev->mask & IN_MOVED_FROM) {
// File moved/renamed from directory...
// check if it's the one we're monitoring.
if(!strcmp(ev->name, cfgName)) {
// It's our file -- stop watching it
if(debug >= 2) {
printf("%s: Config file "
"moved out\n", __progname);
}
inotify_rm_watch(p[33].fd, fileWatch);
close(p[33].fd);
p[33].fd = -1;
p[33].events = 0;
// Pin config is NOT unloaded...
// keep using prior values for now.
} else {
// Some other file -- disregard
}
} else if(ev->mask & (IN_CREATE | IN_MOVED_TO)) {
// File moved/renamed to directory...
// check if it's the one we're monitoring for.
if(!strcmp(ev->name, cfgName)) {
// It's our file -- start watching it!
if(debug >= 2) {
printf("%s: Config file "
"moved in\n", __progname);
}
if(p[33].fd >= 0) { // Existing file?
inotify_rm_watch(
p[33].fd, fileWatch);
close(p[33].fd);
}
p[33].fd = inotify_init();
fileWatch = inotify_add_watch(
p[33].fd, cfgPathname,
IN_MODIFY | IN_IGNORED);
p[33].events = POLLIN;
pinConfigUnload();
pinConfigLoad();
} else {
// Some other file -- disregard
}
}
bufPos += sizeof(struct inotify_event) + ev->len;
}
}
}
// Init and main loop ------------------------------------------------------
int main(int argc, char *argv[]) {
char c; // Pin input value ('0'/'1')
int fd, // For mmap, sysfs
i, // Generic counter
timeout = -1, // poll() timeout
lastKey = -1; // Last key down (for repeat)
uint32_t pressMask[5]; // For Vulcan pinch detect
struct input_event keyEv, synEv; // uinput events
sigset_t sigset; // Signal mask
// If in foreground, set max debug level (config may override)
if(getpgrp() == tcgetpgrp(STDOUT_FILENO)) startupDebug = debug = 99;
// Locate configuration file (if any) and path ---------------------
if(argc > 1) { // First argument (if given) is config file name
char *ptr = strrchr(argv[1], '/'); // Full pathname given?
if(ptr) { // Pathname given; separate into path & name
if(!(cfgPathname = strdup(argv[1])))
err("malloc() fail");
int len = ptr - argv[1]; // Length of path component
if(!len) { // Root path?
cfgPath = "/";
cfgName = &cfgPathname[1];
} else {
if(!(cfgPath = (char *)malloc(len + 1)))
err("malloc() fail");
memcpy(cfgPath, argv[1], len);
cfgPath[len] = 0;
}
} else { // No path given; use /boot directory.
cfgPath = "/boot";
if(!(cfgPathname = (char *)malloc(
strlen(cfgPath) + strlen(argv[1]) + 2)))
err("malloc() fail");
sprintf(cfgPathname, "%s/%s", cfgPath, argv[1]);
}
} else {
// No argument passed -- config file is located in /boot,
// name is "[program name].cfg" (e.g. /boot/retrogame.cfg)
cfgPath = "/boot";
if(!(cfgPathname = (char *)malloc(
strlen(cfgPath) + strlen(__progname) + 6)))
err("malloc() fail");
sprintf(cfgPathname, "%s/%s.cfg", cfgPath, __progname);
}
if(!cfgName) cfgName = &cfgPathname[strlen(cfgPath) + 1];
if(debug) {