2 * freeglut_input_devices.c
4 * Handles miscellaneous input devices via direct serial-port access.
5 * Proper X11 XInput device support is not yet supported.
6 * Also lacks Mac support.
8 * Written by Joe Krahn <krahn@niehs.nih.gov> 2005
10 * Copyright (c) 2005 Stephen J. Baker. All Rights Reserved.
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * PAWEL W. OLSZTA OR STEPHEN J. BAKER BE LIABLE FOR ANY CLAIM, DAMAGES OR
26 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 * DEALINGS IN THE SOFTWARE.
35 #include <GL/freeglut.h>
36 #include "freeglut_internal.h"
38 #if TARGET_HOST_POSIX_X11
42 #include <sys/ioctl.h>
51 #include <sys/types.h>
55 struct termios termio, termio_save;
58 #elif TARGET_HOST_MS_WINDOWS
59 #include <sys/types.h>
63 COMMTIMEOUTS timeouts_save;
69 /********************* Dialbox definitions ***********************/
71 #define DIAL_NUM_VALUATORS 8
73 /* dial parser state machine states */
75 #define DIAL_WHICH_DEVICE 0
76 #define DIAL_VALUE_HIGH 1
77 #define DIAL_VALUE_LOW 2
79 /* dial/button box commands */
80 #define DIAL_INITIALIZE 0x20
81 #define DIAL_SET_LEDS 0x75
82 #define DIAL_SET_TEXT 0x61
83 #define DIAL_SET_AUTO_DIALS 0x50
84 #define DIAL_SET_AUTO_DELTA_DIALS 0x51
85 #define DIAL_SET_FILTER 0x53
86 #define DIAL_SET_BUTTONS_MOM_TYPE 0x71
87 #define DIAL_SET_AUTO_MOM_BUTTONS 0x73
88 #define DIAL_SET_ALL_LEDS 0x4b
89 #define DIAL_CLEAR_ALL_LEDS 0x4c
91 /* dial/button box replies and events */
92 #define DIAL_INITIALIZED 0x20
93 #define DIAL_BASE 0x30
94 #define DIAL_DELTA_BASE 0x40
95 #define DIAL_PRESS_BASE 0xc0
96 #define DIAL_RELEASE_BASE 0xe0
98 /* macros to determine reply type */
99 #define IS_DIAL_EVENT(ch) (((ch)>=DIAL_BASE)&&((ch)<DIAL_BASE+DIAL_NUM_VALUATORS))
100 #define IS_KEY_PRESS(ch) (((ch)>=DIAL_PRESS_BASE)&&((ch)<DIAL_PRESS_BASE+DIAL_NUM_BUTTONS))
101 #define IS_KEY_RELEASE(ch) (((ch)>=DIAL_RELEASE_BASE)&&((ch)<DIAL_RELEASE_BASE+DIAL_NUM_BUTTONS))
102 #define IS_INIT_EVENT(ch) ((ch)==DIAL_INITIALIZED)
104 /*****************************************************************/
106 static SERIALPORT *serial_open ( const char *device );
107 static void serial_close ( SERIALPORT *port );
108 static int serial_getchar ( SERIALPORT *port );
109 static int serial_putchar ( SERIALPORT *port, unsigned char ch );
110 static void serial_flush ( SERIALPORT *port );
112 static void send_dial_event(int dial, int value);
113 static void poll_dials(int id);
115 /* local variables */
116 static SERIALPORT *dialbox_port=NULL;
118 /*****************************************************************/
121 * Implementation for glutDeviceGet(GLUT_HAS_DIAL_AND_BUTTON_BOX)
123 int fgInputDeviceDetect( void )
125 fgInitialiseInputDevices ();
130 if ( !fgState.InputDevsInitialised )
137 * Try initializing the input device(s)
139 void fgInitialiseInputDevices ( void )
141 if( !fgState.InputDevsInitialised )
143 /* will return true for VC8 (VC2005) and higher */
144 #if TARGET_HOST_MS_WINDOWS && ( _MSC_VER >= 1400 ) && HAVE_ERRNO
145 char *dial_device=NULL;
147 errno_t err = _dupenv_s( &dial_device, &sLen, "GLUT_DIALS_SERIAL" );
149 fgError("Error getting GLUT_DIALS_SERIAL environment variable");
151 const char *dial_device=NULL;
152 dial_device = getenv ( "GLUT_DIALS_SERIAL" );
154 #if TARGET_HOST_MS_WINDOWS
156 static char devname[256];
157 DWORD size=sizeof(devname);
160 if (RegOpenKeyA(HKEY_LOCAL_MACHINE,"SOFTWARE\\FreeGLUT",&key)==ERROR_SUCCESS) {
161 if (RegQueryValueExA(key,"DialboxSerialPort",NULL,&type,(LPBYTE)devname,&size)==ERROR_SUCCESS){
168 if ( !dial_device ) return;
169 if ( !( dialbox_port = serial_open ( dial_device ) ) ) return;
170 /* will return true for VC8 (VC2005) and higher */
171 #if TARGET_HOST_MS_WINDOWS && ( _MSC_VER >= 1400 ) && HAVE_ERRNO
172 free ( dial_device ); dial_device = NULL; /* dupenv_s allocates a string that we must free */
174 serial_putchar(dialbox_port,DIAL_INITIALIZE);
175 glutTimerFunc ( 10, poll_dials, 0 );
176 fgState.InputDevsInitialised = GL_TRUE;
183 void fgInputDeviceClose( void )
185 if ( fgState.InputDevsInitialised )
187 serial_close ( dialbox_port );
189 fgState.InputDevsInitialised = GL_FALSE;
193 /********************************************************************/
195 /* Check all windows for dialbox callbacks */
196 static void fghcbEnumDialCallbacks ( SFG_Window *window, SFG_Enumerator *enumerator )
198 /* Built-in to INVOKE_WCB(): if window->Callbacks[CB_Dials] */
199 INVOKE_WCB ( *window,Dials, ( ((int*)enumerator->data)[0], ((int*)enumerator->data)[1]) );
200 fgEnumSubWindows ( window, fghcbEnumDialCallbacks, enumerator );
203 static void send_dial_event ( int num, int value )
205 SFG_Enumerator enumerator;
209 enumerator.found = GL_FALSE;
210 enumerator.data = data;
211 fgEnumWindows ( fghcbEnumDialCallbacks, &enumerator );
214 /********************************************************************/
215 static void poll_dials ( int id )
218 static int dial_state = DIAL_NEW;
219 static int dial_which;
220 static int dial_value;
221 static int dials[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
223 if ( !dialbox_port ) return;
225 while ( (data=serial_getchar(dialbox_port)) != EOF )
227 if ( ( dial_state > DIAL_WHICH_DEVICE ) || IS_DIAL_EVENT ( data ) )
229 switch ( dial_state )
231 case DIAL_WHICH_DEVICE:
232 dial_which = data - DIAL_BASE;
235 case DIAL_VALUE_HIGH:
236 dial_value = ( data << 8 );
241 if ( dial_value & 0x8000 ) dial_value -= 0x10000;
242 dials[dial_which] = dial_value;
243 send_dial_event ( dial_which + 1, dial_value * 360 / 256 );
244 dial_state = DIAL_WHICH_DEVICE;
247 /* error: Impossible state value! */
251 else if ( data == DIAL_INITIALIZED )
253 fgState.InputDevsInitialised = GL_TRUE;
254 dial_state = DIAL_WHICH_DEVICE;
255 serial_putchar(dialbox_port,DIAL_SET_AUTO_DIALS);
256 serial_putchar(dialbox_port,0xff);
257 serial_putchar(dialbox_port,0xff);
259 else /* Unknown data; try flushing. */
260 serial_flush(dialbox_port);
263 glutTimerFunc ( 2, poll_dials, 0 );
267 /******** OS Specific Serial I/O routines *******/
268 #if TARGET_HOST_POSIX_X11 /* ==> Linux/BSD/UNIX POSIX serial I/O */
269 static SERIALPORT *serial_open ( const char *device )
272 struct termios termio;
275 fd = open(device, O_RDWR | O_NONBLOCK );
281 port = malloc(sizeof(SERIALPORT));
282 memset(port, 0, sizeof(SERIALPORT));
285 /* save current port settings */
286 tcgetattr(fd,&port->termio_save);
288 memset(&termio, 0, sizeof(termio));
289 termio.c_cflag = CS8 | CREAD | HUPCL ;
290 termio.c_iflag = IGNPAR | IGNBRK ;
291 termio.c_cc[VTIME] = 0; /* inter-character timer */
292 termio.c_cc[VMIN] = 1; /* block read until 1 chars received, when blocking I/O */
294 cfsetispeed(&termio, B9600);
295 cfsetospeed(&termio, B9600);
296 tcsetattr(fd,TCSANOW,&termio);
302 static void serial_close(SERIALPORT *port)
306 /* restore old port settings */
307 tcsetattr(port->fd,TCSANOW,&port->termio_save);
313 static int serial_getchar(SERIALPORT *port)
316 if (!port) return EOF;
317 if (read(port->fd,&ch,1)) return ch;
321 static int serial_putchar(SERIALPORT *port, unsigned char ch){
323 return write(port->fd,&ch,1);
326 static void serial_flush ( SERIALPORT *port )
328 tcflush ( port->fd, TCIOFLUSH );
331 #elif TARGET_HOST_MS_WINDOWS
333 static SERIALPORT *serial_open(const char *device){
335 DCB dcb={sizeof(DCB)};
336 COMMTIMEOUTS timeouts;
339 fh = CreateFile(device,GENERIC_READ|GENERIC_WRITE,0,NULL,
340 OPEN_EXISTING,FILE_ATTRIBUTE_NORMAL,NULL);
341 if (!fh) return NULL;
343 port = malloc(sizeof(SERIALPORT));
344 ZeroMemory(port, sizeof(SERIALPORT));
347 /* save current port settings */
348 GetCommState(fh,&port->dcb_save);
349 GetCommTimeouts(fh,&port->timeouts_save);
351 dcb.DCBlength=sizeof(DCB);
352 BuildCommDCB("96,n,8,1",&dcb);
353 SetCommState(fh,&dcb);
355 ZeroMemory(&timeouts,sizeof(timeouts));
356 timeouts.ReadTotalTimeoutConstant=1;
357 timeouts.WriteTotalTimeoutConstant=1;
358 SetCommTimeouts(fh,&timeouts);
365 static void serial_close(SERIALPORT *port){
367 /* restore old port settings */
368 SetCommState(port->fh,&port->dcb_save);
369 SetCommTimeouts(port->fh,&port->timeouts_save);
370 CloseHandle(port->fh);
375 static int serial_getchar(SERIALPORT *port){
378 if (!port) return EOF;
379 if (!ReadFile(port->fh,&ch,1,&n,NULL)) return EOF;
384 static int serial_putchar(SERIALPORT *port, unsigned char ch){
387 return WriteFile(port->fh,&ch,1,&n,NULL);
390 static void serial_flush ( SERIALPORT *port )
392 FlushFileBuffers(port->fh);