git.mutantstargoat.com Git - sball/blob - src/sball.c

   1 #include <stdio.h>
   2 #include <stdlib.h>
   3 #include <string.h>
   4 #include <ctype.h>
   5 #include <time.h>
   6 #include <errno.h>
   7 #include <unistd.h>
   8 #include <fcntl.h>
   9 #include <termios.h>
  10 #include <sys/select.h>
  11 #include <sys/time.h>
  12 #include <sys/ioctl.h>
  13
  14 #define INP_BUF_SZ      256
  15
  16 enum {
  17         SB4000  = 1,
  18         FLIPXY  = 2
  19 };
  20
  21 struct sball {
  22         int fd;
  23         unsigned int flags;
  24         int nbuttons;
  25
  26         char buf[INP_BUF_SZ];
  27         int len;
  28
  29         short mot[6];
  30         unsigned int keystate;
  31
  32         struct termios saved_term;
  33         int saved_mstat;
  34
  35         int (*parse)(struct sball*, int, char*, int);
  36 };
  37
  38 static int stty_sball(struct sball *sb);
  39 static int stty_mag(struct sball *sb);
  40 static void stty_save(struct sball *sb);
  41 static void stty_restore(struct sball *sb);
  42
  43 static int proc_input(struct sball *sb);
  44
  45 static int mag_parsepkt(struct sball *sb, int id, char *data, int len);
  46 static int sball_parsepkt(struct sball *sb, int id, char *data, int len);
  47
  48 static int guess_num_buttons(const char *verstr);
  49
  50 static void make_printable(char *buf, int len);
  51 static int read_timeout(int fd, char *buf, int bufsz, long tm_usec);
  52
  53 static void print_state(struct sball *sb);
  54
  55
  56 struct sball *sball_open(const char *dev)
  57 {
  58         int fd, sz;
  59         char buf[128];
  60         struct sball *sb = 0;
  61
  62         if((fd = open(dev, O_RDWR | O_NOCTTY | O_NONBLOCK)) == -1) {
  63                 fprintf(stderr, "sball_open: failed to open device: %s: %s\n", dev, strerror(errno));
  64                 return 0;
  65         }
  66
  67         if(!(sb = malloc(sizeof *sb))) {
  68                 fprintf(stderr, "sball_open: failed to allocate sball object\n");
  69                 goto err;
  70         }
  71         sb->fd = fd;
  72         sb->flags = 0;
  73         sb->len = 0;
  74
  75         stty_save(sb);
  76
  77         if(stty_sball(sb) == -1) {
  78                 goto err;
  79         }
  80         write(fd, "\r@RESET\r", 8);
  81
  82         if((sz = read_timeout(fd, buf, sizeof buf - 1, 2000000)) > 0 && strstr(buf, "\r@1")) {
  83                 /* we got a response, so it's a spaceball */
  84                 make_printable(buf, sz);
  85                 printf("Spaceball detected: %s\n", buf);
  86
  87                 sb->nbuttons = guess_num_buttons(buf);
  88                 printf("%d buttons\n", sb->nbuttons);
  89
  90                 /* set binary mode and enable automatic data packet sending */
  91                 write(fd, "\rCB\rMSSV\r", 9);
  92
  93                 sb->parse = sball_parsepkt;
  94                 return sb;
  95         }
  96
  97         /* try as a magellan spacemouse */
  98         if(stty_mag(sb) == -1) {
  99                 goto err;
 100         }
 101         write(fd, "vQ\r", 3);
 102
 103         if((sz = read_timeout(fd, buf, sizeof buf - 1, 250000)) > 0 && buf[0] == 'v') {
 104                 make_printable(buf, sz);
 105                 printf("Magellan SpaceMouse detected:\n%s\n", buf);
 106
 107                 sb->nbuttons = guess_num_buttons(buf);
 108                 printf("%d buttons\n", sb->nbuttons);
 109
 110                 /* set 3D mode, not-dominant-axis, pass through motion and button packets */
 111                 write(fd, "m3\r", 3);
 112
 113                 sb->parse = mag_parsepkt;
 114                 return sb;
 115         }
 116
 117 err:
 118         stty_restore(sb);
 119         close(fd);
 120         free(sb);
 121         return 0;
 122 }
 123
 124 void sball_close(struct sball *sb)
 125 {
 126         if(!sb) return;
 127
 128         stty_restore(sb);
 129         close(sb->fd);
 130 }
 131
 132 int sball_fd(struct sball *sb)
 133 {
 134         return sb->fd;
 135 }
 136
 137 int sball_read(struct sball *sb)
 138 {
 139         int sz;
 140
 141         while((sz = read(sb->fd, sb->buf + sb->len,  INP_BUF_SZ - sb->len - 1)) > 0) {
 142                 sb->len += sz;
 143                 proc_input(sb);
 144         }
 145
 146         /* if we fill the input buffer, make a last attempt to parse it, and discard
 147          * it so we can receive more
 148          */
 149         if(sb->len >= INP_BUF_SZ) {
 150                 proc_input(sb);
 151                 sb->len = 0;
 152         }
 153
 154         return 0;
 155 }
 156
 157 int sball_axis(struct sball *sb, int axis)
 158 {
 159         return sb->mot[axis];
 160 }
 161
 162 unsigned int sball_buttons(struct sball *sb)
 163 {
 164         return sb->keystate;
 165 }
 166
 167 int sball_num_buttons(struct sball *sb)
 168 {
 169         return sb->nbuttons;
 170 }
 171
 172 /* Labtec spaceball: 9600 8n1 XON/XOFF */
 173 static int stty_sball(struct sball *sb)
 174 {
 175         int mstat;
 176         struct termios term;
 177
 178         term = sb->saved_term;
 179         term.c_oflag = 0;
 180         term.c_lflag = ICANON;
 181         term.c_cc[VMIN] = 0;
 182         term.c_cc[VTIME] = 0;
 183         term.c_cc[VEOF] = 0;
 184         term.c_cc[VEOL] = '\r';
 185         term.c_cc[VEOL2] = 0;
 186         term.c_cc[VERASE] = 0;
 187         term.c_cc[VKILL] = 0;
 188
 189         term.c_cflag = CLOCAL | CREAD | CS8 | HUPCL;
 190         term.c_iflag = IGNBRK | IGNPAR;
 191
 192         cfsetispeed(&term, B9600);
 193         cfsetospeed(&term, B9600);
 194
 195         if(tcsetattr(sb->fd, TCSAFLUSH, &term) == -1) {
 196                 perror("sball_open: tcsetattr");
 197                 return -1;
 198         }
 199         tcflush(sb->fd, TCIOFLUSH);
 200
 201         mstat = sb->saved_mstat | TIOCM_DTR | TIOCM_RTS;
 202         ioctl(sb->fd, TIOCMGET, &mstat);
 203         return 0;
 204 }
 205
 206 /* Logicad magellan spacemouse: 9600 8n2 CTS/RTS */
 207 static int stty_mag(struct sball *sb)
 208 {
 209         int mstat;
 210         struct termios term;
 211
 212         term = sb->saved_term;
 213         term.c_oflag = 0;
 214         term.c_lflag = ICANON;
 215         term.c_cc[VMIN] = 0;
 216         term.c_cc[VTIME] = 0;
 217         term.c_cc[VEOF] = 0;
 218         term.c_cc[VEOL] = '\r';
 219         term.c_cc[VEOL2] = 0;
 220         term.c_cc[VERASE] = 0;
 221         term.c_cc[VKILL] = 0;
 222
 223         term.c_cflag = CLOCAL | CREAD | CS8 | CSTOPB | HUPCL | CRTSCTS;
 224         term.c_iflag = IGNBRK | IGNPAR;
 225
 226         cfsetispeed(&term, B9600);
 227         cfsetospeed(&term, B9600);
 228
 229         if(tcsetattr(sb->fd, TCSAFLUSH, &term) == -1) {
 230                 perror("sball_open: tcsetattr");
 231                 return -1;
 232         }
 233         tcflush(sb->fd, TCIOFLUSH);
 234
 235         mstat = sb->saved_mstat | TIOCM_DTR | TIOCM_RTS;
 236         ioctl(sb->fd, TIOCMGET, &mstat);
 237         return 0;
 238 }
 239
 240 static void stty_save(struct sball *sb)
 241 {
 242         tcgetattr(sb->fd, &sb->saved_term);
 243         ioctl(sb->fd, TIOCMGET, &sb->saved_mstat);
 244 }
 245
 246 static void stty_restore(struct sball *sb)
 247 {
 248         tcsetattr(sb->fd, TCSAFLUSH, &sb->saved_term);
 249         tcflush(sb->fd, TCIOFLUSH);
 250         ioctl(sb->fd, TIOCMSET, &sb->saved_mstat);
 251 }
 252
 253
 254 static int proc_input(struct sball *sb)
 255 {
 256         int sz;
 257         char *bptr = sb->buf;
 258         char *start = sb->buf;
 259         char *end = sb->buf + sb->len;
 260
 261         /* see if we have a CR in the buffer */
 262         while(bptr < end) {
 263                 if(*bptr == '\r') {
 264                         *bptr = 0;
 265                         sb->parse(sb, *start, start + 1, bptr - start - 1);
 266                         start = ++bptr;
 267                 } else {
 268                         bptr++;
 269                 }
 270         }
 271
 272         sz = start - sb->buf;
 273         if(sz > 0) {
 274                 memmove(sb->buf, start, sz);
 275                 sb->len -= sz;
 276         }
 277         return 0;
 278 }
 279
 280 static int mag_parsepkt(struct sball *sb, int id, char *data, int len)
 281 {
 282         int i;
 283
 284         /*printf("magellan packet: %c - %s (%d bytes)\n", (char)id, data, len);*/
 285
 286         switch(id) {
 287         case 'd':
 288                 if(len != 24) {
 289                         fprintf(stderr, "magellan: invalid data packet, expected 24 bytes, got: %d\n", len);
 290                         return -1;
 291                 }
 292                 for(i=0; i<6; i++) {
 293 #ifdef SBALL_BIG_ENDIAN
 294                         sb->mot[i] = ((((int)data[3] & 0xf) << 12) | (((int)data[2] & 0xf) << 8) |
 295                                         (((int)data[1] & 0xf) << 4) | (data[0] & 0xf)) - 0x8000;
 296 #else
 297                         sb->mot[i] = ((((int)data[0] & 0xf) << 12) | (((int)data[1] & 0xf) << 8) |
 298                                         (((int)data[2] & 0xf) << 4) | (data[3] & 0xf)) - 0x8000;
 299 #endif
 300                         data += 4;
 301                 }
 302                 print_state(sb);
 303                 break;
 304
 305         case 'k':
 306                 if(len != 3) {
 307                         fprintf(stderr, "magellan: invalid keyboard pakcet, expected 3 bytes, got: %d\n", len);
 308                         return -1;
 309                 }
 310                 sb->keystate = (data[0] & 0xf) | ((data[1] & 0xf) << 4) | (((unsigned int)data[2] & 0xf) << 8);
 311                 print_state(sb);
 312                 break;
 313
 314         case 'e':
 315                 if(data[0] == 1) {
 316                         fprintf(stderr, "magellan error: illegal command: %c%c\n", data[1], data[2]);
 317                 } else if(data[0] == 2) {
 318                         fprintf(stderr, "magellan error: framing error\n");
 319                 } else {
 320                         fprintf(stderr, "magellan error: unknown device error\n");
 321                 }
 322                 return -1;
 323
 324         default:
 325                 break;
 326         }
 327         return 0;
 328 }
 329
 330 static int sball_parsepkt(struct sball *sb, int id, char *data, int len)
 331 {
 332         int i;
 333         char c, *rd, *wr;
 334
 335         /* decode data packet, replacing escaped values with the correct ones */
 336         rd = wr = data;
 337         while(rd < data + len) {
 338                 if((c = *rd++) == '^') {
 339                         switch(*rd++) {
 340                         case 'Q':
 341                                 *wr++ = 0x11;   /* XON */
 342                                 break;
 343                         case 'S':
 344                                 *wr++ = 0x13;   /* XOFF */
 345                                 break;
 346                         case 'M':
 347                                 *wr++ = 13;             /* CR */
 348                                 break;
 349                         case '^':
 350                                 *wr++ = '^';
 351                                 break;
 352                         default:
 353                                 fprintf(stderr, "sball decode: ignoring invalid escape code: %xh\n", (unsigned int)c);
 354                         }
 355                 } else {
 356                         *wr++ = c;
 357                 }
 358         }
 359         len = wr - data;        /* update the decoded length */
 360
 361         switch(id) {
 362         case 'D':
 363                 if(len != 14) {
 364                         fprintf(stderr, "sball: invalid data packet, expected 14 bytes, got: %d\n", len);
 365                         return -1;
 366                 }
 367
 368 #ifndef SBALL_BIG_ENDIAN
 369                 for(i=0; i<6; i++) {
 370                         data += 2;
 371                         c = data[0];
 372                         data[0] = data[1];
 373                         data[1] = c;
 374                         sb->mot[i] = *(short*)data;
 375                 }
 376 #else
 377                 memcpy(sb->mot, data + 2, 12);
 378 #endif
 379                 print_state(sb);
 380                 break;
 381
 382         case 'K':
 383                 if(len != 2) {
 384                         fprintf(stderr, "sball: invalid key packet, expected 2 bytes, got: %d\n", len);
 385                         return -1;
 386                 }
 387                 if(sb->flags & SB4000) break;   /* ignore K packets from spaceball 4000 devices */
 388
 389                 /* data[1] bits 0-3 -> buttons 0,1,2,3
 390                  * data[1] bits 4,5 (3003 L/R) -> buttons 0, 1
 391                  * data[0] bits 0-2 -> buttons 4,5,6
 392                  * data[0] bit 4 is (2003 pick) -> button 7
 393                  */
 394                 sb->keystate = (data[1] & 0xf) | ((data[1] >> 4) & 3) | ((data[0] & 7) << 4) |
 395                         ((data[0] & 0x10) >> 1);
 396                 print_state(sb);
 397                 break;
 398
 399         case '.':
 400                 if(len != 2) {
 401                         fprintf(stderr, "sball: invalid sb4k key packet, expected 2 bytes, got: %d\n", len);
 402                         return -1;
 403                 }
 404                 /* spaceball 4000 key packet */
 405                 sb->flags |= SB4000;
 406                 /* update orientation flag (actually don't bother) */
 407                 /*
 408                 if(data[0] & 0x20) {
 409                         sb->flags |= FLIPXY;
 410                 } else {
 411                         sb->flags &= ~FLIPXY;
 412                 }
 413                 */
 414
 415                 /* data[1] bits 0-5 -> buttons 0,1,2,3,4,5
 416                  * data[1] bit 7 -> button 6
 417                  * data[0] bits 0-4 -> buttons 7,8,9,10,11
 418                  */
 419                 sb->keystate = (data[1] & 0x3f) | ((data[1] & 0x80) >> 1) | ((data[0] & 0x1f) << 7);
 420                 print_state(sb);
 421                 break;
 422
 423         case 'E':
 424                 fprintf(stderr, "sball: error:");
 425                 for(i=0; i<len; i++) {
 426                         if(isprint(data[i])) {
 427                                 fprintf(stderr, " %c", data[i]);
 428                         } else {
 429                                 fprintf(stderr, " %02xh", (unsigned int)data[i]);
 430                         }
 431                 }
 432                 break;
 433
 434         case 'M':       /* ignore MSS responses */
 435                 break;
 436
 437         default:
 438                 /* DEBUG */
 439                 fprintf(stderr, "sball: got '%c' packet:", (char)id);
 440                 for(i=0; i<len; i++) {
 441                         fprintf(stderr, " %02x", (unsigned int)data[i]);
 442                 }
 443                 fputc('\n', stderr);
 444         }
 445         return 0;
 446 }
 447
 448 static int guess_num_buttons(const char *verstr)
 449 {
 450         int major, minor;
 451         const char *s, *model;
 452
 453         if((s = strstr(verstr, "Firmware version"))) {  /* spaceball */
 454
 455                 /* if we got a model number, guess based on that */
 456                 if((model = strchr(s, '('))) {
 457                         if(memcmp(model, "(Model ", 7) == 0) {
 458                                 model += 7;
 459                         } else {
 460                                 model++;
 461                         }
 462                         switch(atoi(model)) {
 463                         case 2003:
 464                                 return 8;
 465                         case 3003:
 466                                 return 2;
 467                         case 5000:
 468                                 return 12;
 469                         default:
 470                                 break;
 471                         }
 472                 }
 473                 /* try to guess based on firmware number */
 474                 if(sscanf(s + 17, "%d.%d", &major, &minor) == 2 && major == 2) {
 475                         if(minor == 35 || minor == 62 || minor == 63) {
 476                                 return 2;       /* spaceball 3003/3003C */
 477                         }
 478                         if(minor == 42 || minor == 43 || minor == 45) {
 479                                 /* 2.42 is also used by spaceball 2003C, but this should be
 480                                  * caught before we get here by the model number guess
 481                                  */
 482                                 return 12;      /* spaceball 4000flx/5000flx-a */
 483                         }
 484                         if(minor == 2 || minor == 13 || minor == 15) {
 485                                 return 8;       /* spaceball 1003/2003/2003c */
 486                         }
 487                 }
 488         }
 489
 490         if(strstr(verstr, "MAGELLAN")) {
 491                 return 9; /* magellan spacemouse */
 492         }
 493
 494         if(strstr(verstr, "SPACEBALL")) {
 495                 return 12; /* spaceball 5000 */
 496         }
 497
 498         if(strstr(verstr, "CadMan")) {
 499                 return 2;
 500         }
 501
 502         fprintf(stderr, "Can't guess number of buttons, default to 8, report this as a bug!\n");
 503         return 8;
 504 }
 505
 506 static void make_printable(char *buf, int len)
 507 {
 508         int i, c;
 509         char *wr = buf;
 510
 511         for(i=0; i<len; i++) {
 512                 c = *buf++;
 513                 if(c == '\r') {
 514                         *wr++ = '\n';
 515                         while(*buf == '\n' || *buf == '\r') buf++;
 516                 } else {
 517                         *wr++ = c;
 518                 }
 519         }
 520         *wr = 0;
 521 }
 522
 523 static int read_timeout(int fd, char *buf, int bufsz, long tm_usec)
 524 {
 525         int res;
 526         long usec, sz = 0;
 527         struct timeval tv0, tv;
 528         fd_set rdset;
 529
 530         if(!buf || bufsz <= 0) return -1;
 531
 532         usec = tm_usec;
 533         gettimeofday(&tv0, 0);
 534
 535         while(sz < bufsz && usec > 0) {
 536                 tv.tv_sec = usec / 1000000;
 537                 tv.tv_usec = usec % 1000000;
 538
 539                 FD_ZERO(&rdset);
 540                 FD_SET(fd, &rdset);
 541                 if((res = select(fd + 1, &rdset, 0, 0, &tv)) > 0 && FD_ISSET(fd, &rdset)) {
 542                         sz += read(fd, buf + sz, bufsz - sz);
 543                         buf[sz] = 0;
 544                         tm_usec = usec = 128000;        /* wait 128ms for the rest of the message to appear */
 545                         gettimeofday(&tv0, 0);
 546                         continue;
 547                 }
 548                 if(res == -1 && (errno == EWOULDBLOCK || errno == EAGAIN)) {
 549                         break;
 550                 }
 551                 gettimeofday(&tv, 0);
 552                 usec = tm_usec - ((tv.tv_sec - tv0.tv_sec) * 1000000 + (tv.tv_usec - tv0.tv_usec));
 553         }
 554
 555         return sz > 0 ? sz : -1;
 556 }
 557
 558 static void print_motion(short *mot)
 559 {
 560         printf(" T[%+6d %+6d %+6d]  R[%+6d %+6d %+6d]", mot[0], mot[1],
 561                         mot[2], mot[3], mot[4], mot[5]);
 562 }
 563
 564 static void print_keystate(unsigned int keystate)
 565 {
 566         int i;
 567
 568         for(i=0; i<12; i++) {
 569                 int b = 11 - i;
 570                 int hex = b < 10 ? b + '0' : b - 10 + 'a';
 571                 putchar(keystate & (1 << b) ? hex : '-');
 572         }
 573 }
 574
 575 static void print_state(struct sball *sb)
 576 {
 577         print_motion(sb->mot);
 578         printf("  B[");
 579         print_keystate(sb->keystate);
 580         printf("]\r");
 581         fflush(stdout);
 582 }