1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 *  Copyright (c) 1999-2001 Vojtech Pavlik
4 *
5 *  Based on the work of:
6 *	James Banks		Matthew Dillon
7 *	David Giller		Nathan Laredo
8 *	Linus Torvalds		Johan Myreen
9 *	Cliff Matthews		Philip Blundell
10 *	Russell King
11 */
12
13/*
14 * Logitech Bus Mouse Driver for Linux
15 */
16
17#include <linux/module.h>
18#include <linux/delay.h>
19#include <linux/ioport.h>
20#include <linux/init.h>
21#include <linux/input.h>
22#include <linux/interrupt.h>
23
24#include <asm/io.h>
25#include <asm/irq.h>
26
27MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
28MODULE_DESCRIPTION("Logitech busmouse driver");
29MODULE_LICENSE("GPL");
30
31#define	LOGIBM_BASE		0x23c
32#define	LOGIBM_EXTENT		4
33
34#define	LOGIBM_DATA_PORT	LOGIBM_BASE + 0
35#define	LOGIBM_SIGNATURE_PORT	LOGIBM_BASE + 1
36#define	LOGIBM_CONTROL_PORT	LOGIBM_BASE + 2
37#define	LOGIBM_CONFIG_PORT	LOGIBM_BASE + 3
38
39#define	LOGIBM_ENABLE_IRQ	0x00
40#define	LOGIBM_DISABLE_IRQ	0x10
41#define	LOGIBM_READ_X_LOW	0x80
42#define	LOGIBM_READ_X_HIGH	0xa0
43#define	LOGIBM_READ_Y_LOW	0xc0
44#define	LOGIBM_READ_Y_HIGH	0xe0
45
46#define LOGIBM_DEFAULT_MODE	0x90
47#define LOGIBM_CONFIG_BYTE	0x91
48#define LOGIBM_SIGNATURE_BYTE	0xa5
49
50#define LOGIBM_IRQ		5
51
52static int logibm_irq = LOGIBM_IRQ;
53module_param_hw_named(irq, logibm_irq, uint, irq, 0);
54MODULE_PARM_DESC(irq, "IRQ number (5=default)");
55
56static struct input_dev *logibm_dev;
57
58static irqreturn_t logibm_interrupt(int irq, void *dev_id)
59{
60	char dx, dy;
61	unsigned char buttons;
62
63	outb(LOGIBM_READ_X_LOW, LOGIBM_CONTROL_PORT);
64	dx = (inb(LOGIBM_DATA_PORT) & 0xf);
65	outb(LOGIBM_READ_X_HIGH, LOGIBM_CONTROL_PORT);
66	dx |= (inb(LOGIBM_DATA_PORT) & 0xf) << 4;
67	outb(LOGIBM_READ_Y_LOW, LOGIBM_CONTROL_PORT);
68	dy = (inb(LOGIBM_DATA_PORT) & 0xf);
69	outb(LOGIBM_READ_Y_HIGH, LOGIBM_CONTROL_PORT);
70	buttons = inb(LOGIBM_DATA_PORT);
71	dy |= (buttons & 0xf) << 4;
72	buttons = ~buttons >> 5;
73
74	input_report_rel(logibm_dev, REL_X, dx);
75	input_report_rel(logibm_dev, REL_Y, dy);
76	input_report_key(logibm_dev, BTN_RIGHT,  buttons & 1);
77	input_report_key(logibm_dev, BTN_MIDDLE, buttons & 2);
78	input_report_key(logibm_dev, BTN_LEFT,   buttons & 4);
79	input_sync(logibm_dev);
80
81	outb(LOGIBM_ENABLE_IRQ, LOGIBM_CONTROL_PORT);
82	return IRQ_HANDLED;
83}
84
85static int logibm_open(struct input_dev *dev)
86{
87	if (request_irq(logibm_irq, logibm_interrupt, 0, "logibm", NULL)) {
88		printk(KERN_ERR "logibm.c: Can't allocate irq %d\n", logibm_irq);
89		return -EBUSY;
90	}
91	outb(LOGIBM_ENABLE_IRQ, LOGIBM_CONTROL_PORT);
92	return 0;
93}
94
95static void logibm_close(struct input_dev *dev)
96{
97	outb(LOGIBM_DISABLE_IRQ, LOGIBM_CONTROL_PORT);
98	free_irq(logibm_irq, NULL);
99}
100
101static int __init logibm_init(void)
102{
103	int err;
104
105	if (!request_region(LOGIBM_BASE, LOGIBM_EXTENT, "logibm")) {
106		printk(KERN_ERR "logibm.c: Can't allocate ports at %#x\n", LOGIBM_BASE);
107		return -EBUSY;
108	}
109
110	outb(LOGIBM_CONFIG_BYTE, LOGIBM_CONFIG_PORT);
111	outb(LOGIBM_SIGNATURE_BYTE, LOGIBM_SIGNATURE_PORT);
112	udelay(100);
113
114	if (inb(LOGIBM_SIGNATURE_PORT) != LOGIBM_SIGNATURE_BYTE) {
115		printk(KERN_INFO "logibm.c: Didn't find Logitech busmouse at %#x\n", LOGIBM_BASE);
116		err = -ENODEV;
117		goto err_release_region;
118	}
119
120	outb(LOGIBM_DEFAULT_MODE, LOGIBM_CONFIG_PORT);
121	outb(LOGIBM_DISABLE_IRQ, LOGIBM_CONTROL_PORT);
122
123	logibm_dev = input_allocate_device();
124	if (!logibm_dev) {
125		printk(KERN_ERR "logibm.c: Not enough memory for input device\n");
126		err = -ENOMEM;
127		goto err_release_region;
128	}
129
130	logibm_dev->name = "Logitech bus mouse";
131	logibm_dev->phys = "isa023c/input0";
132	logibm_dev->id.bustype = BUS_ISA;
133	logibm_dev->id.vendor  = 0x0003;
134	logibm_dev->id.product = 0x0001;
135	logibm_dev->id.version = 0x0100;
136
137	logibm_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
138	logibm_dev->keybit[BIT_WORD(BTN_LEFT)] = BIT_MASK(BTN_LEFT) |
139		BIT_MASK(BTN_MIDDLE) | BIT_MASK(BTN_RIGHT);
140	logibm_dev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
141
142	logibm_dev->open  = logibm_open;
143	logibm_dev->close = logibm_close;
144
145	err = input_register_device(logibm_dev);
146	if (err)
147		goto err_free_dev;
148
149	return 0;
150
151 err_free_dev:
152	input_free_device(logibm_dev);
153 err_release_region:
154	release_region(LOGIBM_BASE, LOGIBM_EXTENT);
155
156	return err;
157}
158
159static void __exit logibm_exit(void)
160{
161	input_unregister_device(logibm_dev);
162	release_region(LOGIBM_BASE, LOGIBM_EXTENT);
163}
164
165module_init(logibm_init);
166module_exit(logibm_exit);
167