Linux Audio

Check our new training course

Loading...
v4.6
 
  1/*
  2 *  Copyright (c) 1996-2001 Vojtech Pavlik
  3 */
  4
  5/*
  6 * Analog joystick and gamepad driver for Linux
  7 */
  8
  9/*
 10 * This program is free software; you can redistribute it and/or modify
 11 * it under the terms of the GNU General Public License as published by
 12 * the Free Software Foundation; either version 2 of the License, or
 13 * (at your option) any later version.
 14 *
 15 * This program is distributed in the hope that it will be useful,
 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 18 * GNU General Public License for more details.
 19 *
 20 * You should have received a copy of the GNU General Public License
 21 * along with this program; if not, write to the Free Software
 22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 23 *
 24 * Should you need to contact me, the author, you can do so either by
 25 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
 26 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
 27 */
 28
 29#include <linux/delay.h>
 30#include <linux/kernel.h>
 31#include <linux/module.h>
 32#include <linux/slab.h>
 33#include <linux/bitops.h>
 34#include <linux/init.h>
 35#include <linux/input.h>
 36#include <linux/gameport.h>
 37#include <linux/jiffies.h>
 38#include <linux/timex.h>
 39#include <linux/timekeeping.h>
 40
 41#define DRIVER_DESC	"Analog joystick and gamepad driver"
 42
 43MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
 44MODULE_DESCRIPTION(DRIVER_DESC);
 45MODULE_LICENSE("GPL");
 46
 47static bool use_ktime = true;
 48module_param(use_ktime, bool, 0400);
 49MODULE_PARM_DESC(use_ktime, "Use ktime for measuring I/O speed");
 50
 51/*
 52 * Option parsing.
 53 */
 54
 55#define ANALOG_PORTS		16
 56
 57static char *js[ANALOG_PORTS];
 58static unsigned int js_nargs;
 59static int analog_options[ANALOG_PORTS];
 60module_param_array_named(map, js, charp, &js_nargs, 0);
 61MODULE_PARM_DESC(map, "Describes analog joysticks type/capabilities");
 62
 63/*
 64 * Times, feature definitions.
 65 */
 66
 67#define ANALOG_RUDDER		0x00004
 68#define ANALOG_THROTTLE		0x00008
 69#define ANALOG_AXES_STD		0x0000f
 70#define ANALOG_BTNS_STD		0x000f0
 71
 72#define ANALOG_BTNS_CHF		0x00100
 73#define ANALOG_HAT1_CHF		0x00200
 74#define ANALOG_HAT2_CHF		0x00400
 75#define ANALOG_HAT_FCS		0x00800
 76#define ANALOG_HATS_ALL		0x00e00
 77#define ANALOG_BTN_TL		0x01000
 78#define ANALOG_BTN_TR		0x02000
 79#define ANALOG_BTN_TL2		0x04000
 80#define ANALOG_BTN_TR2		0x08000
 81#define ANALOG_BTNS_TLR		0x03000
 82#define ANALOG_BTNS_TLR2	0x0c000
 83#define ANALOG_BTNS_GAMEPAD	0x0f000
 84
 85#define ANALOG_HBTN_CHF		0x10000
 86#define ANALOG_ANY_CHF		0x10700
 87#define ANALOG_SAITEK		0x20000
 88#define ANALOG_EXTENSIONS	0x7ff00
 89#define ANALOG_GAMEPAD		0x80000
 90
 91#define ANALOG_MAX_TIME		3	/* 3 ms */
 92#define ANALOG_LOOP_TIME	2000	/* 2 * loop */
 93#define ANALOG_SAITEK_DELAY	200	/* 200 us */
 94#define ANALOG_SAITEK_TIME	2000	/* 2000 us */
 95#define ANALOG_AXIS_TIME	2	/* 2 * refresh */
 96#define ANALOG_INIT_RETRIES	8	/* 8 times */
 97#define ANALOG_FUZZ_BITS	2	/* 2 bit more */
 98#define ANALOG_FUZZ_MAGIC	36	/* 36 u*ms/loop */
 99
100#define ANALOG_MAX_NAME_LENGTH  128
101#define ANALOG_MAX_PHYS_LENGTH	32
102
103static short analog_axes[] = { ABS_X, ABS_Y, ABS_RUDDER, ABS_THROTTLE };
104static short analog_hats[] = { ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, ABS_HAT2X, ABS_HAT2Y };
105static short analog_pads[] = { BTN_Y, BTN_Z, BTN_TL, BTN_TR };
106static short analog_exts[] = { ANALOG_HAT1_CHF, ANALOG_HAT2_CHF, ANALOG_HAT_FCS };
107static short analog_pad_btn[] = { BTN_A, BTN_B, BTN_C, BTN_X, BTN_TL2, BTN_TR2, BTN_SELECT, BTN_START, BTN_MODE, BTN_BASE };
108static short analog_joy_btn[] = { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2,
109				  BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_BASE6 };
110
111static unsigned char analog_chf[] = { 0xf, 0x0, 0x1, 0x9, 0x2, 0x4, 0xc, 0x8, 0x3, 0x5, 0xb, 0x7, 0xd, 0xe, 0xa, 0x6 };
112
113struct analog {
114	struct input_dev *dev;
115	int mask;
116	short *buttons;
117	char name[ANALOG_MAX_NAME_LENGTH];
118	char phys[ANALOG_MAX_PHYS_LENGTH];
119};
120
121struct analog_port {
122	struct gameport *gameport;
123	struct analog analog[2];
124	unsigned char mask;
125	char saitek;
126	char cooked;
127	int bads;
128	int reads;
129	int speed;
130	int loop;
131	int fuzz;
132	int axes[4];
133	int buttons;
134	int initial[4];
135	int axtime;
136};
137
138/*
139 * Time macros.
140 */
141
142#ifdef __i386__
143
144#include <linux/i8253.h>
145
146#define GET_TIME(x)	do { if (cpu_has_tsc) x = (unsigned int)rdtsc(); else x = get_time_pit(); } while (0)
147#define DELTA(x,y)	(cpu_has_tsc ? ((y) - (x)) : ((x) - (y) + ((x) < (y) ? PIT_TICK_RATE / HZ : 0)))
148#define TIME_NAME	(cpu_has_tsc?"TSC":"PIT")
149static unsigned int get_time_pit(void)
150{
151        unsigned long flags;
152        unsigned int count;
153
154        raw_spin_lock_irqsave(&i8253_lock, flags);
155        outb_p(0x00, 0x43);
156        count = inb_p(0x40);
157        count |= inb_p(0x40) << 8;
158        raw_spin_unlock_irqrestore(&i8253_lock, flags);
159
160        return count;
161}
162#elif defined(__x86_64__)
163#define GET_TIME(x)	do { x = (unsigned int)rdtsc(); } while (0)
164#define DELTA(x,y)	((y)-(x))
165#define TIME_NAME	"TSC"
166#elif defined(__alpha__) || defined(CONFIG_MN10300) || defined(CONFIG_ARM) || defined(CONFIG_ARM64) || defined(CONFIG_TILE)
167#define GET_TIME(x)	do { x = get_cycles(); } while (0)
168#define DELTA(x,y)	((y)-(x))
169#define TIME_NAME	"get_cycles"
170#else
171#define FAKE_TIME
172static unsigned long analog_faketime = 0;
173#define GET_TIME(x)     do { x = analog_faketime++; } while(0)
174#define DELTA(x,y)	((y)-(x))
175#define TIME_NAME	"Unreliable"
176#warning Precise timer not defined for this architecture.
177#endif
178
179static inline u64 get_time(void)
180{
181	if (use_ktime) {
182		return ktime_get_ns();
183	} else {
184		unsigned int x;
185		GET_TIME(x);
186		return x;
187	}
188}
189
190static inline unsigned int delta(u64 x, u64 y)
191{
192	if (use_ktime)
193		return y - x;
194	else
195		return DELTA((unsigned int)x, (unsigned int)y);
196}
197
198/*
199 * analog_decode() decodes analog joystick data and reports input events.
200 */
201
202static void analog_decode(struct analog *analog, int *axes, int *initial, int buttons)
203{
204	struct input_dev *dev = analog->dev;
205	int i, j;
206
207	if (analog->mask & ANALOG_HAT_FCS)
208		for (i = 0; i < 4; i++)
209			if (axes[3] < ((initial[3] * ((i << 1) + 1)) >> 3)) {
210				buttons |= 1 << (i + 14);
211				break;
212			}
213
214	for (i = j = 0; i < 6; i++)
215		if (analog->mask & (0x10 << i))
216			input_report_key(dev, analog->buttons[j++], (buttons >> i) & 1);
217
218	if (analog->mask & ANALOG_HBTN_CHF)
219		for (i = 0; i < 4; i++)
220			input_report_key(dev, analog->buttons[j++], (buttons >> (i + 10)) & 1);
221
222	if (analog->mask & ANALOG_BTN_TL)
223		input_report_key(dev, analog_pads[0], axes[2] < (initial[2] >> 1));
224	if (analog->mask & ANALOG_BTN_TR)
225		input_report_key(dev, analog_pads[1], axes[3] < (initial[3] >> 1));
226	if (analog->mask & ANALOG_BTN_TL2)
227		input_report_key(dev, analog_pads[2], axes[2] > (initial[2] + (initial[2] >> 1)));
228	if (analog->mask & ANALOG_BTN_TR2)
229		input_report_key(dev, analog_pads[3], axes[3] > (initial[3] + (initial[3] >> 1)));
230
231	for (i = j = 0; i < 4; i++)
232		if (analog->mask & (1 << i))
233			input_report_abs(dev, analog_axes[j++], axes[i]);
234
235	for (i = j = 0; i < 3; i++)
236		if (analog->mask & analog_exts[i]) {
237			input_report_abs(dev, analog_hats[j++],
238				((buttons >> ((i << 2) + 7)) & 1) - ((buttons >> ((i << 2) + 9)) & 1));
239			input_report_abs(dev, analog_hats[j++],
240				((buttons >> ((i << 2) + 8)) & 1) - ((buttons >> ((i << 2) + 6)) & 1));
241		}
242
243	input_sync(dev);
244}
245
246/*
247 * analog_cooked_read() reads analog joystick data.
248 */
249
250static int analog_cooked_read(struct analog_port *port)
251{
252	struct gameport *gameport = port->gameport;
253	u64 time[4], start, loop, now;
254	unsigned int loopout, timeout;
255	unsigned char data[4], this, last;
256	unsigned long flags;
257	int i, j;
258
259	loopout = (ANALOG_LOOP_TIME * port->loop) / 1000;
260	timeout = ANALOG_MAX_TIME * port->speed;
261
262	local_irq_save(flags);
263	gameport_trigger(gameport);
264	now = get_time();
265	local_irq_restore(flags);
266
267	start = now;
268	this = port->mask;
269	i = 0;
270
271	do {
272		loop = now;
273		last = this;
274
275		local_irq_disable();
276		this = gameport_read(gameport) & port->mask;
277		now = get_time();
278		local_irq_restore(flags);
279
280		if ((last ^ this) && (delta(loop, now) < loopout)) {
281			data[i] = last ^ this;
282			time[i] = now;
283			i++;
284		}
285
286	} while (this && (i < 4) && (delta(start, now) < timeout));
287
288	this <<= 4;
289
290	for (--i; i >= 0; i--) {
291		this |= data[i];
292		for (j = 0; j < 4; j++)
293			if (data[i] & (1 << j))
294				port->axes[j] = (delta(start, time[i]) << ANALOG_FUZZ_BITS) / port->loop;
295	}
296
297	return -(this != port->mask);
298}
299
300static int analog_button_read(struct analog_port *port, char saitek, char chf)
301{
302	unsigned char u;
303	int t = 1, i = 0;
304	int strobe = gameport_time(port->gameport, ANALOG_SAITEK_TIME);
305
306	u = gameport_read(port->gameport);
307
308	if (!chf) {
309		port->buttons = (~u >> 4) & 0xf;
310		return 0;
311	}
312
313	port->buttons = 0;
314
315	while ((~u & 0xf0) && (i < 16) && t) {
316		port->buttons |= 1 << analog_chf[(~u >> 4) & 0xf];
317		if (!saitek) return 0;
318		udelay(ANALOG_SAITEK_DELAY);
319		t = strobe;
320		gameport_trigger(port->gameport);
321		while (((u = gameport_read(port->gameport)) & port->mask) && t) t--;
322		i++;
323	}
324
325	return -(!t || (i == 16));
326}
327
328/*
329 * analog_poll() repeatedly polls the Analog joysticks.
330 */
331
332static void analog_poll(struct gameport *gameport)
333{
334	struct analog_port *port = gameport_get_drvdata(gameport);
335	int i;
336
337	char saitek = !!(port->analog[0].mask & ANALOG_SAITEK);
338	char chf = !!(port->analog[0].mask & ANALOG_ANY_CHF);
339
340	if (port->cooked) {
341		port->bads -= gameport_cooked_read(port->gameport, port->axes, &port->buttons);
342		if (chf)
343			port->buttons = port->buttons ? (1 << analog_chf[port->buttons]) : 0;
344		port->reads++;
345	} else {
346		if (!port->axtime--) {
347			port->bads -= analog_cooked_read(port);
348			port->bads -= analog_button_read(port, saitek, chf);
349			port->reads++;
350			port->axtime = ANALOG_AXIS_TIME - 1;
351		} else {
352			if (!saitek)
353				analog_button_read(port, saitek, chf);
354		}
355	}
356
357	for (i = 0; i < 2; i++)
358		if (port->analog[i].mask)
359			analog_decode(port->analog + i, port->axes, port->initial, port->buttons);
360}
361
362/*
363 * analog_open() is a callback from the input open routine.
364 */
365
366static int analog_open(struct input_dev *dev)
367{
368	struct analog_port *port = input_get_drvdata(dev);
369
370	gameport_start_polling(port->gameport);
371	return 0;
372}
373
374/*
375 * analog_close() is a callback from the input close routine.
376 */
377
378static void analog_close(struct input_dev *dev)
379{
380	struct analog_port *port = input_get_drvdata(dev);
381
382	gameport_stop_polling(port->gameport);
383}
384
385/*
386 * analog_calibrate_timer() calibrates the timer and computes loop
387 * and timeout values for a joystick port.
388 */
389
390static void analog_calibrate_timer(struct analog_port *port)
391{
392	struct gameport *gameport = port->gameport;
393	unsigned int i, t, tx;
394	u64 t1, t2, t3;
395	unsigned long flags;
396
397	if (use_ktime) {
398		port->speed = 1000000;
399	} else {
400		local_irq_save(flags);
401		t1 = get_time();
402#ifdef FAKE_TIME
403		analog_faketime += 830;
404#endif
405		mdelay(1);
406		t2 = get_time();
407		t3 = get_time();
408		local_irq_restore(flags);
409
410		port->speed = delta(t1, t2) - delta(t2, t3);
411	}
412
413	tx = ~0;
414
415	for (i = 0; i < 50; i++) {
416		local_irq_save(flags);
417		t1 = get_time();
418		for (t = 0; t < 50; t++) {
419			gameport_read(gameport);
420			t2 = get_time();
421		}
422		t3 = get_time();
423		local_irq_restore(flags);
424		udelay(i);
425		t = delta(t1, t2) - delta(t2, t3);
426		if (t < tx) tx = t;
427	}
428
429        port->loop = tx / 50;
430}
431
432/*
433 * analog_name() constructs a name for an analog joystick.
434 */
435
436static void analog_name(struct analog *analog)
437{
438	snprintf(analog->name, sizeof(analog->name), "Analog %d-axis %d-button",
439		 hweight8(analog->mask & ANALOG_AXES_STD),
440		 hweight8(analog->mask & ANALOG_BTNS_STD) + !!(analog->mask & ANALOG_BTNS_CHF) * 2 +
441		 hweight16(analog->mask & ANALOG_BTNS_GAMEPAD) + !!(analog->mask & ANALOG_HBTN_CHF) * 4);
442
443	if (analog->mask & ANALOG_HATS_ALL)
444		snprintf(analog->name, sizeof(analog->name), "%s %d-hat",
445			 analog->name, hweight16(analog->mask & ANALOG_HATS_ALL));
446
447	if (analog->mask & ANALOG_HAT_FCS)
448		strlcat(analog->name, " FCS", sizeof(analog->name));
449	if (analog->mask & ANALOG_ANY_CHF)
450		strlcat(analog->name, (analog->mask & ANALOG_SAITEK) ? " Saitek" : " CHF",
451			sizeof(analog->name));
452
453	strlcat(analog->name, (analog->mask & ANALOG_GAMEPAD) ? " gamepad": " joystick",
454		sizeof(analog->name));
455}
456
457/*
458 * analog_init_device()
459 */
460
461static int analog_init_device(struct analog_port *port, struct analog *analog, int index)
462{
463	struct input_dev *input_dev;
464	int i, j, t, v, w, x, y, z;
465	int error;
466
467	analog_name(analog);
468	snprintf(analog->phys, sizeof(analog->phys),
469		 "%s/input%d", port->gameport->phys, index);
470	analog->buttons = (analog->mask & ANALOG_GAMEPAD) ? analog_pad_btn : analog_joy_btn;
471
472	analog->dev = input_dev = input_allocate_device();
473	if (!input_dev)
474		return -ENOMEM;
475
476	input_dev->name = analog->name;
477	input_dev->phys = analog->phys;
478	input_dev->id.bustype = BUS_GAMEPORT;
479	input_dev->id.vendor = GAMEPORT_ID_VENDOR_ANALOG;
480	input_dev->id.product = analog->mask >> 4;
481	input_dev->id.version = 0x0100;
482	input_dev->dev.parent = &port->gameport->dev;
483
484	input_set_drvdata(input_dev, port);
485
486	input_dev->open = analog_open;
487	input_dev->close = analog_close;
488
489	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
490
491	for (i = j = 0; i < 4; i++)
492		if (analog->mask & (1 << i)) {
493
494			t = analog_axes[j];
495			x = port->axes[i];
496			y = (port->axes[0] + port->axes[1]) >> 1;
497			z = y - port->axes[i];
498			z = z > 0 ? z : -z;
499			v = (x >> 3);
500			w = (x >> 3);
501
502			if ((i == 2 || i == 3) && (j == 2 || j == 3) && (z > (y >> 3)))
503				x = y;
504
505			if (analog->mask & ANALOG_SAITEK) {
506				if (i == 2) x = port->axes[i];
507				v = x - (x >> 2);
508				w = (x >> 4);
509			}
510
511			input_set_abs_params(input_dev, t, v, (x << 1) - v, port->fuzz, w);
512			j++;
513		}
514
515	for (i = j = 0; i < 3; i++)
516		if (analog->mask & analog_exts[i])
517			for (x = 0; x < 2; x++) {
518				t = analog_hats[j++];
519				input_set_abs_params(input_dev, t, -1, 1, 0, 0);
520			}
521
522	for (i = j = 0; i < 4; i++)
523		if (analog->mask & (0x10 << i))
524			set_bit(analog->buttons[j++], input_dev->keybit);
525
526	if (analog->mask & ANALOG_BTNS_CHF)
527		for (i = 0; i < 2; i++)
528			set_bit(analog->buttons[j++], input_dev->keybit);
529
530	if (analog->mask & ANALOG_HBTN_CHF)
531		for (i = 0; i < 4; i++)
532			set_bit(analog->buttons[j++], input_dev->keybit);
533
534	for (i = 0; i < 4; i++)
535		if (analog->mask & (ANALOG_BTN_TL << i))
536			set_bit(analog_pads[i], input_dev->keybit);
537
538	analog_decode(analog, port->axes, port->initial, port->buttons);
539
540	error = input_register_device(analog->dev);
541	if (error) {
542		input_free_device(analog->dev);
543		return error;
544	}
545
546	return 0;
547}
548
549/*
550 * analog_init_devices() sets up device-specific values and registers the input devices.
551 */
552
553static int analog_init_masks(struct analog_port *port)
554{
555	int i;
556	struct analog *analog = port->analog;
557	int max[4];
558
559	if (!port->mask)
560		return -1;
561
562	if ((port->mask & 3) != 3 && port->mask != 0xc) {
563		printk(KERN_WARNING "analog.c: Unknown joystick device found  "
564			"(data=%#x, %s), probably not analog joystick.\n",
565			port->mask, port->gameport->phys);
566		return -1;
567	}
568
569
570	i = analog_options[0]; /* FIXME !!! - need to specify options for different ports */
571
572	analog[0].mask = i & 0xfffff;
573
574	analog[0].mask &= ~(ANALOG_AXES_STD | ANALOG_HAT_FCS | ANALOG_BTNS_GAMEPAD)
575			| port->mask | ((port->mask << 8) & ANALOG_HAT_FCS)
576			| ((port->mask << 10) & ANALOG_BTNS_TLR) | ((port->mask << 12) & ANALOG_BTNS_TLR2);
577
578	analog[0].mask &= ~(ANALOG_HAT2_CHF)
579			| ((analog[0].mask & ANALOG_HBTN_CHF) ? 0 : ANALOG_HAT2_CHF);
580
581	analog[0].mask &= ~(ANALOG_THROTTLE | ANALOG_BTN_TR | ANALOG_BTN_TR2)
582			| ((~analog[0].mask & ANALOG_HAT_FCS) >> 8)
583			| ((~analog[0].mask & ANALOG_HAT_FCS) << 2)
584			| ((~analog[0].mask & ANALOG_HAT_FCS) << 4);
585
586	analog[0].mask &= ~(ANALOG_THROTTLE | ANALOG_RUDDER)
587			| (((~analog[0].mask & ANALOG_BTNS_TLR ) >> 10)
588			&  ((~analog[0].mask & ANALOG_BTNS_TLR2) >> 12));
589
590	analog[1].mask = ((i >> 20) & 0xff) | ((i >> 12) & 0xf0000);
591
592	analog[1].mask &= (analog[0].mask & ANALOG_EXTENSIONS) ? ANALOG_GAMEPAD
593			: (((ANALOG_BTNS_STD | port->mask) & ~analog[0].mask) | ANALOG_GAMEPAD);
594
595	if (port->cooked) {
596
597		for (i = 0; i < 4; i++) max[i] = port->axes[i] << 1;
598
599		if ((analog[0].mask & 0x7) == 0x7) max[2] = (max[0] + max[1]) >> 1;
600		if ((analog[0].mask & 0xb) == 0xb) max[3] = (max[0] + max[1]) >> 1;
601		if ((analog[0].mask & ANALOG_BTN_TL) && !(analog[0].mask & ANALOG_BTN_TL2)) max[2] >>= 1;
602		if ((analog[0].mask & ANALOG_BTN_TR) && !(analog[0].mask & ANALOG_BTN_TR2)) max[3] >>= 1;
603		if ((analog[0].mask & ANALOG_HAT_FCS)) max[3] >>= 1;
604
605		gameport_calibrate(port->gameport, port->axes, max);
606	}
607
608	for (i = 0; i < 4; i++)
609		port->initial[i] = port->axes[i];
610
611	return -!(analog[0].mask || analog[1].mask);
612}
613
614static int analog_init_port(struct gameport *gameport, struct gameport_driver *drv, struct analog_port *port)
615{
616	int i, t, u, v;
617
618	port->gameport = gameport;
619
620	gameport_set_drvdata(gameport, port);
621
622	if (!gameport_open(gameport, drv, GAMEPORT_MODE_RAW)) {
623
624		analog_calibrate_timer(port);
625
626		gameport_trigger(gameport);
627		t = gameport_read(gameport);
628		msleep(ANALOG_MAX_TIME);
629		port->mask = (gameport_read(gameport) ^ t) & t & 0xf;
630		port->fuzz = (port->speed * ANALOG_FUZZ_MAGIC) / port->loop / 1000 + ANALOG_FUZZ_BITS;
631
632		for (i = 0; i < ANALOG_INIT_RETRIES; i++) {
633			if (!analog_cooked_read(port))
634				break;
635			msleep(ANALOG_MAX_TIME);
636		}
637
638		u = v = 0;
639
640		msleep(ANALOG_MAX_TIME);
641		t = gameport_time(gameport, ANALOG_MAX_TIME * 1000);
642		gameport_trigger(gameport);
643		while ((gameport_read(port->gameport) & port->mask) && (u < t))
644			u++;
645		udelay(ANALOG_SAITEK_DELAY);
646		t = gameport_time(gameport, ANALOG_SAITEK_TIME);
647		gameport_trigger(gameport);
648		while ((gameport_read(port->gameport) & port->mask) && (v < t))
649			v++;
650
651		if (v < (u >> 1)) { /* FIXME - more than one port */
652			analog_options[0] |= /* FIXME - more than one port */
653				ANALOG_SAITEK | ANALOG_BTNS_CHF | ANALOG_HBTN_CHF | ANALOG_HAT1_CHF;
654			return 0;
655		}
656
657		gameport_close(gameport);
658	}
659
660	if (!gameport_open(gameport, drv, GAMEPORT_MODE_COOKED)) {
661
662		for (i = 0; i < ANALOG_INIT_RETRIES; i++)
663			if (!gameport_cooked_read(gameport, port->axes, &port->buttons))
664				break;
665		for (i = 0; i < 4; i++)
666			if (port->axes[i] != -1)
667				port->mask |= 1 << i;
668
669		port->fuzz = gameport->fuzz;
670		port->cooked = 1;
671		return 0;
672	}
673
674	return gameport_open(gameport, drv, GAMEPORT_MODE_RAW);
675}
676
677static int analog_connect(struct gameport *gameport, struct gameport_driver *drv)
678{
679	struct analog_port *port;
680	int i;
681	int err;
682
683	if (!(port = kzalloc(sizeof(struct analog_port), GFP_KERNEL)))
684		return - ENOMEM;
685
686	err = analog_init_port(gameport, drv, port);
687	if (err)
688		goto fail1;
689
690	err = analog_init_masks(port);
691	if (err)
692		goto fail2;
693
694	gameport_set_poll_handler(gameport, analog_poll);
695	gameport_set_poll_interval(gameport, 10);
696
697	for (i = 0; i < 2; i++)
698		if (port->analog[i].mask) {
699			err = analog_init_device(port, port->analog + i, i);
700			if (err)
701				goto fail3;
702		}
703
704	return 0;
705
706 fail3: while (--i >= 0)
707		if (port->analog[i].mask)
708			input_unregister_device(port->analog[i].dev);
709 fail2:	gameport_close(gameport);
710 fail1:	gameport_set_drvdata(gameport, NULL);
711	kfree(port);
712	return err;
713}
714
715static void analog_disconnect(struct gameport *gameport)
716{
717	struct analog_port *port = gameport_get_drvdata(gameport);
718	int i;
719
720	for (i = 0; i < 2; i++)
721		if (port->analog[i].mask)
722			input_unregister_device(port->analog[i].dev);
723	gameport_close(gameport);
724	gameport_set_drvdata(gameport, NULL);
725	printk(KERN_INFO "analog.c: %d out of %d reads (%d%%) on %s failed\n",
726		port->bads, port->reads, port->reads ? (port->bads * 100 / port->reads) : 0,
727		port->gameport->phys);
728	kfree(port);
729}
730
731struct analog_types {
732	char *name;
733	int value;
734};
735
736static struct analog_types analog_types[] = {
737	{ "none",	0x00000000 },
738	{ "auto",	0x000000ff },
739	{ "2btn",	0x0000003f },
740	{ "y-joy",	0x0cc00033 },
741	{ "y-pad",	0x8cc80033 },
742	{ "fcs",	0x000008f7 },
743	{ "chf",	0x000002ff },
744	{ "fullchf",	0x000007ff },
745	{ "gamepad",	0x000830f3 },
746	{ "gamepad8",	0x0008f0f3 },
747	{ NULL, 0 }
748};
749
750static void analog_parse_options(void)
751{
752	int i, j;
753	char *end;
754
755	for (i = 0; i < js_nargs; i++) {
756
757		for (j = 0; analog_types[j].name; j++)
758			if (!strcmp(analog_types[j].name, js[i])) {
759				analog_options[i] = analog_types[j].value;
760				break;
761			}
762		if (analog_types[j].name) continue;
763
764		analog_options[i] = simple_strtoul(js[i], &end, 0);
765		if (end != js[i]) continue;
766
767		analog_options[i] = 0xff;
768		if (!strlen(js[i])) continue;
769
770		printk(KERN_WARNING "analog.c: Bad config for port %d - \"%s\"\n", i, js[i]);
771	}
772
773	for (; i < ANALOG_PORTS; i++)
774		analog_options[i] = 0xff;
775}
776
777/*
778 * The gameport device structure.
779 */
780
781static struct gameport_driver analog_drv = {
782	.driver		= {
783		.name	= "analog",
784	},
785	.description	= DRIVER_DESC,
786	.connect	= analog_connect,
787	.disconnect	= analog_disconnect,
788};
789
790static int __init analog_init(void)
791{
792	analog_parse_options();
793	return gameport_register_driver(&analog_drv);
794}
795
796static void __exit analog_exit(void)
797{
798	gameport_unregister_driver(&analog_drv);
799}
800
801module_init(analog_init);
802module_exit(analog_exit);
v5.4
  1// SPDX-License-Identifier: GPL-2.0-or-later
  2/*
  3 *  Copyright (c) 1996-2001 Vojtech Pavlik
  4 */
  5
  6/*
  7 * Analog joystick and gamepad driver for Linux
  8 */
  9
 10/*
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 11 */
 12
 13#include <linux/delay.h>
 14#include <linux/kernel.h>
 15#include <linux/module.h>
 16#include <linux/slab.h>
 17#include <linux/bitops.h>
 18#include <linux/init.h>
 19#include <linux/input.h>
 20#include <linux/gameport.h>
 21#include <linux/jiffies.h>
 22#include <linux/timex.h>
 23#include <linux/timekeeping.h>
 24
 25#define DRIVER_DESC	"Analog joystick and gamepad driver"
 26
 27MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
 28MODULE_DESCRIPTION(DRIVER_DESC);
 29MODULE_LICENSE("GPL");
 30
 31static bool use_ktime = true;
 32module_param(use_ktime, bool, 0400);
 33MODULE_PARM_DESC(use_ktime, "Use ktime for measuring I/O speed");
 34
 35/*
 36 * Option parsing.
 37 */
 38
 39#define ANALOG_PORTS		16
 40
 41static char *js[ANALOG_PORTS];
 42static unsigned int js_nargs;
 43static int analog_options[ANALOG_PORTS];
 44module_param_array_named(map, js, charp, &js_nargs, 0);
 45MODULE_PARM_DESC(map, "Describes analog joysticks type/capabilities");
 46
 47/*
 48 * Times, feature definitions.
 49 */
 50
 51#define ANALOG_RUDDER		0x00004
 52#define ANALOG_THROTTLE		0x00008
 53#define ANALOG_AXES_STD		0x0000f
 54#define ANALOG_BTNS_STD		0x000f0
 55
 56#define ANALOG_BTNS_CHF		0x00100
 57#define ANALOG_HAT1_CHF		0x00200
 58#define ANALOG_HAT2_CHF		0x00400
 59#define ANALOG_HAT_FCS		0x00800
 60#define ANALOG_HATS_ALL		0x00e00
 61#define ANALOG_BTN_TL		0x01000
 62#define ANALOG_BTN_TR		0x02000
 63#define ANALOG_BTN_TL2		0x04000
 64#define ANALOG_BTN_TR2		0x08000
 65#define ANALOG_BTNS_TLR		0x03000
 66#define ANALOG_BTNS_TLR2	0x0c000
 67#define ANALOG_BTNS_GAMEPAD	0x0f000
 68
 69#define ANALOG_HBTN_CHF		0x10000
 70#define ANALOG_ANY_CHF		0x10700
 71#define ANALOG_SAITEK		0x20000
 72#define ANALOG_EXTENSIONS	0x7ff00
 73#define ANALOG_GAMEPAD		0x80000
 74
 75#define ANALOG_MAX_TIME		3	/* 3 ms */
 76#define ANALOG_LOOP_TIME	2000	/* 2 * loop */
 77#define ANALOG_SAITEK_DELAY	200	/* 200 us */
 78#define ANALOG_SAITEK_TIME	2000	/* 2000 us */
 79#define ANALOG_AXIS_TIME	2	/* 2 * refresh */
 80#define ANALOG_INIT_RETRIES	8	/* 8 times */
 81#define ANALOG_FUZZ_BITS	2	/* 2 bit more */
 82#define ANALOG_FUZZ_MAGIC	36	/* 36 u*ms/loop */
 83
 84#define ANALOG_MAX_NAME_LENGTH  128
 85#define ANALOG_MAX_PHYS_LENGTH	32
 86
 87static short analog_axes[] = { ABS_X, ABS_Y, ABS_RUDDER, ABS_THROTTLE };
 88static short analog_hats[] = { ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, ABS_HAT2X, ABS_HAT2Y };
 89static short analog_pads[] = { BTN_Y, BTN_Z, BTN_TL, BTN_TR };
 90static short analog_exts[] = { ANALOG_HAT1_CHF, ANALOG_HAT2_CHF, ANALOG_HAT_FCS };
 91static short analog_pad_btn[] = { BTN_A, BTN_B, BTN_C, BTN_X, BTN_TL2, BTN_TR2, BTN_SELECT, BTN_START, BTN_MODE, BTN_BASE };
 92static short analog_joy_btn[] = { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2,
 93				  BTN_BASE3, BTN_BASE4, BTN_BASE5, BTN_BASE6 };
 94
 95static unsigned char analog_chf[] = { 0xf, 0x0, 0x1, 0x9, 0x2, 0x4, 0xc, 0x8, 0x3, 0x5, 0xb, 0x7, 0xd, 0xe, 0xa, 0x6 };
 96
 97struct analog {
 98	struct input_dev *dev;
 99	int mask;
100	short *buttons;
101	char name[ANALOG_MAX_NAME_LENGTH];
102	char phys[ANALOG_MAX_PHYS_LENGTH];
103};
104
105struct analog_port {
106	struct gameport *gameport;
107	struct analog analog[2];
108	unsigned char mask;
109	char saitek;
110	char cooked;
111	int bads;
112	int reads;
113	int speed;
114	int loop;
115	int fuzz;
116	int axes[4];
117	int buttons;
118	int initial[4];
119	int axtime;
120};
121
122/*
123 * Time macros.
124 */
125
126#ifdef __i386__
127
128#include <linux/i8253.h>
129
130#define GET_TIME(x)	do { if (boot_cpu_has(X86_FEATURE_TSC)) x = (unsigned int)rdtsc(); else x = get_time_pit(); } while (0)
131#define DELTA(x,y)	(boot_cpu_has(X86_FEATURE_TSC) ? ((y) - (x)) : ((x) - (y) + ((x) < (y) ? PIT_TICK_RATE / HZ : 0)))
132#define TIME_NAME	(boot_cpu_has(X86_FEATURE_TSC)?"TSC":"PIT")
133static unsigned int get_time_pit(void)
134{
135        unsigned long flags;
136        unsigned int count;
137
138        raw_spin_lock_irqsave(&i8253_lock, flags);
139        outb_p(0x00, 0x43);
140        count = inb_p(0x40);
141        count |= inb_p(0x40) << 8;
142        raw_spin_unlock_irqrestore(&i8253_lock, flags);
143
144        return count;
145}
146#elif defined(__x86_64__)
147#define GET_TIME(x)	do { x = (unsigned int)rdtsc(); } while (0)
148#define DELTA(x,y)	((y)-(x))
149#define TIME_NAME	"TSC"
150#elif defined(__alpha__) || defined(CONFIG_ARM) || defined(CONFIG_ARM64) || defined(CONFIG_PPC) || defined(CONFIG_RISCV)
151#define GET_TIME(x)	do { x = get_cycles(); } while (0)
152#define DELTA(x,y)	((y)-(x))
153#define TIME_NAME	"get_cycles"
154#else
155#define FAKE_TIME
156static unsigned long analog_faketime = 0;
157#define GET_TIME(x)     do { x = analog_faketime++; } while(0)
158#define DELTA(x,y)	((y)-(x))
159#define TIME_NAME	"Unreliable"
160#warning Precise timer not defined for this architecture.
161#endif
162
163static inline u64 get_time(void)
164{
165	if (use_ktime) {
166		return ktime_get_ns();
167	} else {
168		unsigned int x;
169		GET_TIME(x);
170		return x;
171	}
172}
173
174static inline unsigned int delta(u64 x, u64 y)
175{
176	if (use_ktime)
177		return y - x;
178	else
179		return DELTA((unsigned int)x, (unsigned int)y);
180}
181
182/*
183 * analog_decode() decodes analog joystick data and reports input events.
184 */
185
186static void analog_decode(struct analog *analog, int *axes, int *initial, int buttons)
187{
188	struct input_dev *dev = analog->dev;
189	int i, j;
190
191	if (analog->mask & ANALOG_HAT_FCS)
192		for (i = 0; i < 4; i++)
193			if (axes[3] < ((initial[3] * ((i << 1) + 1)) >> 3)) {
194				buttons |= 1 << (i + 14);
195				break;
196			}
197
198	for (i = j = 0; i < 6; i++)
199		if (analog->mask & (0x10 << i))
200			input_report_key(dev, analog->buttons[j++], (buttons >> i) & 1);
201
202	if (analog->mask & ANALOG_HBTN_CHF)
203		for (i = 0; i < 4; i++)
204			input_report_key(dev, analog->buttons[j++], (buttons >> (i + 10)) & 1);
205
206	if (analog->mask & ANALOG_BTN_TL)
207		input_report_key(dev, analog_pads[0], axes[2] < (initial[2] >> 1));
208	if (analog->mask & ANALOG_BTN_TR)
209		input_report_key(dev, analog_pads[1], axes[3] < (initial[3] >> 1));
210	if (analog->mask & ANALOG_BTN_TL2)
211		input_report_key(dev, analog_pads[2], axes[2] > (initial[2] + (initial[2] >> 1)));
212	if (analog->mask & ANALOG_BTN_TR2)
213		input_report_key(dev, analog_pads[3], axes[3] > (initial[3] + (initial[3] >> 1)));
214
215	for (i = j = 0; i < 4; i++)
216		if (analog->mask & (1 << i))
217			input_report_abs(dev, analog_axes[j++], axes[i]);
218
219	for (i = j = 0; i < 3; i++)
220		if (analog->mask & analog_exts[i]) {
221			input_report_abs(dev, analog_hats[j++],
222				((buttons >> ((i << 2) + 7)) & 1) - ((buttons >> ((i << 2) + 9)) & 1));
223			input_report_abs(dev, analog_hats[j++],
224				((buttons >> ((i << 2) + 8)) & 1) - ((buttons >> ((i << 2) + 6)) & 1));
225		}
226
227	input_sync(dev);
228}
229
230/*
231 * analog_cooked_read() reads analog joystick data.
232 */
233
234static int analog_cooked_read(struct analog_port *port)
235{
236	struct gameport *gameport = port->gameport;
237	u64 time[4], start, loop, now;
238	unsigned int loopout, timeout;
239	unsigned char data[4], this, last;
240	unsigned long flags;
241	int i, j;
242
243	loopout = (ANALOG_LOOP_TIME * port->loop) / 1000;
244	timeout = ANALOG_MAX_TIME * port->speed;
245
246	local_irq_save(flags);
247	gameport_trigger(gameport);
248	now = get_time();
249	local_irq_restore(flags);
250
251	start = now;
252	this = port->mask;
253	i = 0;
254
255	do {
256		loop = now;
257		last = this;
258
259		local_irq_disable();
260		this = gameport_read(gameport) & port->mask;
261		now = get_time();
262		local_irq_restore(flags);
263
264		if ((last ^ this) && (delta(loop, now) < loopout)) {
265			data[i] = last ^ this;
266			time[i] = now;
267			i++;
268		}
269
270	} while (this && (i < 4) && (delta(start, now) < timeout));
271
272	this <<= 4;
273
274	for (--i; i >= 0; i--) {
275		this |= data[i];
276		for (j = 0; j < 4; j++)
277			if (data[i] & (1 << j))
278				port->axes[j] = (delta(start, time[i]) << ANALOG_FUZZ_BITS) / port->loop;
279	}
280
281	return -(this != port->mask);
282}
283
284static int analog_button_read(struct analog_port *port, char saitek, char chf)
285{
286	unsigned char u;
287	int t = 1, i = 0;
288	int strobe = gameport_time(port->gameport, ANALOG_SAITEK_TIME);
289
290	u = gameport_read(port->gameport);
291
292	if (!chf) {
293		port->buttons = (~u >> 4) & 0xf;
294		return 0;
295	}
296
297	port->buttons = 0;
298
299	while ((~u & 0xf0) && (i < 16) && t) {
300		port->buttons |= 1 << analog_chf[(~u >> 4) & 0xf];
301		if (!saitek) return 0;
302		udelay(ANALOG_SAITEK_DELAY);
303		t = strobe;
304		gameport_trigger(port->gameport);
305		while (((u = gameport_read(port->gameport)) & port->mask) && t) t--;
306		i++;
307	}
308
309	return -(!t || (i == 16));
310}
311
312/*
313 * analog_poll() repeatedly polls the Analog joysticks.
314 */
315
316static void analog_poll(struct gameport *gameport)
317{
318	struct analog_port *port = gameport_get_drvdata(gameport);
319	int i;
320
321	char saitek = !!(port->analog[0].mask & ANALOG_SAITEK);
322	char chf = !!(port->analog[0].mask & ANALOG_ANY_CHF);
323
324	if (port->cooked) {
325		port->bads -= gameport_cooked_read(port->gameport, port->axes, &port->buttons);
326		if (chf)
327			port->buttons = port->buttons ? (1 << analog_chf[port->buttons]) : 0;
328		port->reads++;
329	} else {
330		if (!port->axtime--) {
331			port->bads -= analog_cooked_read(port);
332			port->bads -= analog_button_read(port, saitek, chf);
333			port->reads++;
334			port->axtime = ANALOG_AXIS_TIME - 1;
335		} else {
336			if (!saitek)
337				analog_button_read(port, saitek, chf);
338		}
339	}
340
341	for (i = 0; i < 2; i++)
342		if (port->analog[i].mask)
343			analog_decode(port->analog + i, port->axes, port->initial, port->buttons);
344}
345
346/*
347 * analog_open() is a callback from the input open routine.
348 */
349
350static int analog_open(struct input_dev *dev)
351{
352	struct analog_port *port = input_get_drvdata(dev);
353
354	gameport_start_polling(port->gameport);
355	return 0;
356}
357
358/*
359 * analog_close() is a callback from the input close routine.
360 */
361
362static void analog_close(struct input_dev *dev)
363{
364	struct analog_port *port = input_get_drvdata(dev);
365
366	gameport_stop_polling(port->gameport);
367}
368
369/*
370 * analog_calibrate_timer() calibrates the timer and computes loop
371 * and timeout values for a joystick port.
372 */
373
374static void analog_calibrate_timer(struct analog_port *port)
375{
376	struct gameport *gameport = port->gameport;
377	unsigned int i, t, tx;
378	u64 t1, t2, t3;
379	unsigned long flags;
380
381	if (use_ktime) {
382		port->speed = 1000000;
383	} else {
384		local_irq_save(flags);
385		t1 = get_time();
386#ifdef FAKE_TIME
387		analog_faketime += 830;
388#endif
389		mdelay(1);
390		t2 = get_time();
391		t3 = get_time();
392		local_irq_restore(flags);
393
394		port->speed = delta(t1, t2) - delta(t2, t3);
395	}
396
397	tx = ~0;
398
399	for (i = 0; i < 50; i++) {
400		local_irq_save(flags);
401		t1 = get_time();
402		for (t = 0; t < 50; t++) {
403			gameport_read(gameport);
404			t2 = get_time();
405		}
406		t3 = get_time();
407		local_irq_restore(flags);
408		udelay(i);
409		t = delta(t1, t2) - delta(t2, t3);
410		if (t < tx) tx = t;
411	}
412
413        port->loop = tx / 50;
414}
415
416/*
417 * analog_name() constructs a name for an analog joystick.
418 */
419
420static void analog_name(struct analog *analog)
421{
422	snprintf(analog->name, sizeof(analog->name), "Analog %d-axis %d-button",
423		 hweight8(analog->mask & ANALOG_AXES_STD),
424		 hweight8(analog->mask & ANALOG_BTNS_STD) + !!(analog->mask & ANALOG_BTNS_CHF) * 2 +
425		 hweight16(analog->mask & ANALOG_BTNS_GAMEPAD) + !!(analog->mask & ANALOG_HBTN_CHF) * 4);
426
427	if (analog->mask & ANALOG_HATS_ALL)
428		snprintf(analog->name, sizeof(analog->name), "%s %d-hat",
429			 analog->name, hweight16(analog->mask & ANALOG_HATS_ALL));
430
431	if (analog->mask & ANALOG_HAT_FCS)
432		strlcat(analog->name, " FCS", sizeof(analog->name));
433	if (analog->mask & ANALOG_ANY_CHF)
434		strlcat(analog->name, (analog->mask & ANALOG_SAITEK) ? " Saitek" : " CHF",
435			sizeof(analog->name));
436
437	strlcat(analog->name, (analog->mask & ANALOG_GAMEPAD) ? " gamepad": " joystick",
438		sizeof(analog->name));
439}
440
441/*
442 * analog_init_device()
443 */
444
445static int analog_init_device(struct analog_port *port, struct analog *analog, int index)
446{
447	struct input_dev *input_dev;
448	int i, j, t, v, w, x, y, z;
449	int error;
450
451	analog_name(analog);
452	snprintf(analog->phys, sizeof(analog->phys),
453		 "%s/input%d", port->gameport->phys, index);
454	analog->buttons = (analog->mask & ANALOG_GAMEPAD) ? analog_pad_btn : analog_joy_btn;
455
456	analog->dev = input_dev = input_allocate_device();
457	if (!input_dev)
458		return -ENOMEM;
459
460	input_dev->name = analog->name;
461	input_dev->phys = analog->phys;
462	input_dev->id.bustype = BUS_GAMEPORT;
463	input_dev->id.vendor = GAMEPORT_ID_VENDOR_ANALOG;
464	input_dev->id.product = analog->mask >> 4;
465	input_dev->id.version = 0x0100;
466	input_dev->dev.parent = &port->gameport->dev;
467
468	input_set_drvdata(input_dev, port);
469
470	input_dev->open = analog_open;
471	input_dev->close = analog_close;
472
473	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
474
475	for (i = j = 0; i < 4; i++)
476		if (analog->mask & (1 << i)) {
477
478			t = analog_axes[j];
479			x = port->axes[i];
480			y = (port->axes[0] + port->axes[1]) >> 1;
481			z = y - port->axes[i];
482			z = z > 0 ? z : -z;
483			v = (x >> 3);
484			w = (x >> 3);
485
486			if ((i == 2 || i == 3) && (j == 2 || j == 3) && (z > (y >> 3)))
487				x = y;
488
489			if (analog->mask & ANALOG_SAITEK) {
490				if (i == 2) x = port->axes[i];
491				v = x - (x >> 2);
492				w = (x >> 4);
493			}
494
495			input_set_abs_params(input_dev, t, v, (x << 1) - v, port->fuzz, w);
496			j++;
497		}
498
499	for (i = j = 0; i < 3; i++)
500		if (analog->mask & analog_exts[i])
501			for (x = 0; x < 2; x++) {
502				t = analog_hats[j++];
503				input_set_abs_params(input_dev, t, -1, 1, 0, 0);
504			}
505
506	for (i = j = 0; i < 4; i++)
507		if (analog->mask & (0x10 << i))
508			set_bit(analog->buttons[j++], input_dev->keybit);
509
510	if (analog->mask & ANALOG_BTNS_CHF)
511		for (i = 0; i < 2; i++)
512			set_bit(analog->buttons[j++], input_dev->keybit);
513
514	if (analog->mask & ANALOG_HBTN_CHF)
515		for (i = 0; i < 4; i++)
516			set_bit(analog->buttons[j++], input_dev->keybit);
517
518	for (i = 0; i < 4; i++)
519		if (analog->mask & (ANALOG_BTN_TL << i))
520			set_bit(analog_pads[i], input_dev->keybit);
521
522	analog_decode(analog, port->axes, port->initial, port->buttons);
523
524	error = input_register_device(analog->dev);
525	if (error) {
526		input_free_device(analog->dev);
527		return error;
528	}
529
530	return 0;
531}
532
533/*
534 * analog_init_devices() sets up device-specific values and registers the input devices.
535 */
536
537static int analog_init_masks(struct analog_port *port)
538{
539	int i;
540	struct analog *analog = port->analog;
541	int max[4];
542
543	if (!port->mask)
544		return -1;
545
546	if ((port->mask & 3) != 3 && port->mask != 0xc) {
547		printk(KERN_WARNING "analog.c: Unknown joystick device found  "
548			"(data=%#x, %s), probably not analog joystick.\n",
549			port->mask, port->gameport->phys);
550		return -1;
551	}
552
553
554	i = analog_options[0]; /* FIXME !!! - need to specify options for different ports */
555
556	analog[0].mask = i & 0xfffff;
557
558	analog[0].mask &= ~(ANALOG_AXES_STD | ANALOG_HAT_FCS | ANALOG_BTNS_GAMEPAD)
559			| port->mask | ((port->mask << 8) & ANALOG_HAT_FCS)
560			| ((port->mask << 10) & ANALOG_BTNS_TLR) | ((port->mask << 12) & ANALOG_BTNS_TLR2);
561
562	analog[0].mask &= ~(ANALOG_HAT2_CHF)
563			| ((analog[0].mask & ANALOG_HBTN_CHF) ? 0 : ANALOG_HAT2_CHF);
564
565	analog[0].mask &= ~(ANALOG_THROTTLE | ANALOG_BTN_TR | ANALOG_BTN_TR2)
566			| ((~analog[0].mask & ANALOG_HAT_FCS) >> 8)
567			| ((~analog[0].mask & ANALOG_HAT_FCS) << 2)
568			| ((~analog[0].mask & ANALOG_HAT_FCS) << 4);
569
570	analog[0].mask &= ~(ANALOG_THROTTLE | ANALOG_RUDDER)
571			| (((~analog[0].mask & ANALOG_BTNS_TLR ) >> 10)
572			&  ((~analog[0].mask & ANALOG_BTNS_TLR2) >> 12));
573
574	analog[1].mask = ((i >> 20) & 0xff) | ((i >> 12) & 0xf0000);
575
576	analog[1].mask &= (analog[0].mask & ANALOG_EXTENSIONS) ? ANALOG_GAMEPAD
577			: (((ANALOG_BTNS_STD | port->mask) & ~analog[0].mask) | ANALOG_GAMEPAD);
578
579	if (port->cooked) {
580
581		for (i = 0; i < 4; i++) max[i] = port->axes[i] << 1;
582
583		if ((analog[0].mask & 0x7) == 0x7) max[2] = (max[0] + max[1]) >> 1;
584		if ((analog[0].mask & 0xb) == 0xb) max[3] = (max[0] + max[1]) >> 1;
585		if ((analog[0].mask & ANALOG_BTN_TL) && !(analog[0].mask & ANALOG_BTN_TL2)) max[2] >>= 1;
586		if ((analog[0].mask & ANALOG_BTN_TR) && !(analog[0].mask & ANALOG_BTN_TR2)) max[3] >>= 1;
587		if ((analog[0].mask & ANALOG_HAT_FCS)) max[3] >>= 1;
588
589		gameport_calibrate(port->gameport, port->axes, max);
590	}
591
592	for (i = 0; i < 4; i++)
593		port->initial[i] = port->axes[i];
594
595	return -!(analog[0].mask || analog[1].mask);
596}
597
598static int analog_init_port(struct gameport *gameport, struct gameport_driver *drv, struct analog_port *port)
599{
600	int i, t, u, v;
601
602	port->gameport = gameport;
603
604	gameport_set_drvdata(gameport, port);
605
606	if (!gameport_open(gameport, drv, GAMEPORT_MODE_RAW)) {
607
608		analog_calibrate_timer(port);
609
610		gameport_trigger(gameport);
611		t = gameport_read(gameport);
612		msleep(ANALOG_MAX_TIME);
613		port->mask = (gameport_read(gameport) ^ t) & t & 0xf;
614		port->fuzz = (port->speed * ANALOG_FUZZ_MAGIC) / port->loop / 1000 + ANALOG_FUZZ_BITS;
615
616		for (i = 0; i < ANALOG_INIT_RETRIES; i++) {
617			if (!analog_cooked_read(port))
618				break;
619			msleep(ANALOG_MAX_TIME);
620		}
621
622		u = v = 0;
623
624		msleep(ANALOG_MAX_TIME);
625		t = gameport_time(gameport, ANALOG_MAX_TIME * 1000);
626		gameport_trigger(gameport);
627		while ((gameport_read(port->gameport) & port->mask) && (u < t))
628			u++;
629		udelay(ANALOG_SAITEK_DELAY);
630		t = gameport_time(gameport, ANALOG_SAITEK_TIME);
631		gameport_trigger(gameport);
632		while ((gameport_read(port->gameport) & port->mask) && (v < t))
633			v++;
634
635		if (v < (u >> 1)) { /* FIXME - more than one port */
636			analog_options[0] |= /* FIXME - more than one port */
637				ANALOG_SAITEK | ANALOG_BTNS_CHF | ANALOG_HBTN_CHF | ANALOG_HAT1_CHF;
638			return 0;
639		}
640
641		gameport_close(gameport);
642	}
643
644	if (!gameport_open(gameport, drv, GAMEPORT_MODE_COOKED)) {
645
646		for (i = 0; i < ANALOG_INIT_RETRIES; i++)
647			if (!gameport_cooked_read(gameport, port->axes, &port->buttons))
648				break;
649		for (i = 0; i < 4; i++)
650			if (port->axes[i] != -1)
651				port->mask |= 1 << i;
652
653		port->fuzz = gameport->fuzz;
654		port->cooked = 1;
655		return 0;
656	}
657
658	return gameport_open(gameport, drv, GAMEPORT_MODE_RAW);
659}
660
661static int analog_connect(struct gameport *gameport, struct gameport_driver *drv)
662{
663	struct analog_port *port;
664	int i;
665	int err;
666
667	if (!(port = kzalloc(sizeof(struct analog_port), GFP_KERNEL)))
668		return - ENOMEM;
669
670	err = analog_init_port(gameport, drv, port);
671	if (err)
672		goto fail1;
673
674	err = analog_init_masks(port);
675	if (err)
676		goto fail2;
677
678	gameport_set_poll_handler(gameport, analog_poll);
679	gameport_set_poll_interval(gameport, 10);
680
681	for (i = 0; i < 2; i++)
682		if (port->analog[i].mask) {
683			err = analog_init_device(port, port->analog + i, i);
684			if (err)
685				goto fail3;
686		}
687
688	return 0;
689
690 fail3: while (--i >= 0)
691		if (port->analog[i].mask)
692			input_unregister_device(port->analog[i].dev);
693 fail2:	gameport_close(gameport);
694 fail1:	gameport_set_drvdata(gameport, NULL);
695	kfree(port);
696	return err;
697}
698
699static void analog_disconnect(struct gameport *gameport)
700{
701	struct analog_port *port = gameport_get_drvdata(gameport);
702	int i;
703
704	for (i = 0; i < 2; i++)
705		if (port->analog[i].mask)
706			input_unregister_device(port->analog[i].dev);
707	gameport_close(gameport);
708	gameport_set_drvdata(gameport, NULL);
709	printk(KERN_INFO "analog.c: %d out of %d reads (%d%%) on %s failed\n",
710		port->bads, port->reads, port->reads ? (port->bads * 100 / port->reads) : 0,
711		port->gameport->phys);
712	kfree(port);
713}
714
715struct analog_types {
716	char *name;
717	int value;
718};
719
720static struct analog_types analog_types[] = {
721	{ "none",	0x00000000 },
722	{ "auto",	0x000000ff },
723	{ "2btn",	0x0000003f },
724	{ "y-joy",	0x0cc00033 },
725	{ "y-pad",	0x8cc80033 },
726	{ "fcs",	0x000008f7 },
727	{ "chf",	0x000002ff },
728	{ "fullchf",	0x000007ff },
729	{ "gamepad",	0x000830f3 },
730	{ "gamepad8",	0x0008f0f3 },
731	{ NULL, 0 }
732};
733
734static void analog_parse_options(void)
735{
736	int i, j;
737	char *end;
738
739	for (i = 0; i < js_nargs; i++) {
740
741		for (j = 0; analog_types[j].name; j++)
742			if (!strcmp(analog_types[j].name, js[i])) {
743				analog_options[i] = analog_types[j].value;
744				break;
745			}
746		if (analog_types[j].name) continue;
747
748		analog_options[i] = simple_strtoul(js[i], &end, 0);
749		if (end != js[i]) continue;
750
751		analog_options[i] = 0xff;
752		if (!strlen(js[i])) continue;
753
754		printk(KERN_WARNING "analog.c: Bad config for port %d - \"%s\"\n", i, js[i]);
755	}
756
757	for (; i < ANALOG_PORTS; i++)
758		analog_options[i] = 0xff;
759}
760
761/*
762 * The gameport device structure.
763 */
764
765static struct gameport_driver analog_drv = {
766	.driver		= {
767		.name	= "analog",
768	},
769	.description	= DRIVER_DESC,
770	.connect	= analog_connect,
771	.disconnect	= analog_disconnect,
772};
773
774static int __init analog_init(void)
775{
776	analog_parse_options();
777	return gameport_register_driver(&analog_drv);
778}
779
780static void __exit analog_exit(void)
781{
782	gameport_unregister_driver(&analog_drv);
783}
784
785module_init(analog_init);
786module_exit(analog_exit);