2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (C) 2008 Nathan Whitehorn
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include <sys/cdefs.h>
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/module.h>
36 #include <sys/mouse.h>
38 #include <sys/condvar.h>
39 #include <sys/selinfo.h>
40 #include <sys/sysctl.h>
42 #include <sys/fcntl.h>
43 #include <sys/kernel.h>
45 #include <machine/bus.h>
52 #define CDEV_GET_SOFTC(x) (x)->si_drv1
54 static int adb_mouse_probe(device_t dev);
55 static int adb_mouse_attach(device_t dev);
56 static int adb_mouse_detach(device_t dev);
57 static void adb_init_trackpad(device_t dev);
58 static int adb_tapping_sysctl(SYSCTL_HANDLER_ARGS);
60 static d_open_t ams_open;
61 static d_close_t ams_close;
62 static d_read_t ams_read;
63 static d_ioctl_t ams_ioctl;
64 static d_poll_t ams_poll;
66 static u_int adb_mouse_receive_packet(device_t dev, u_char status,
67 u_char command, u_char reg, int len, u_char *data);
69 struct adb_mouse_softc {
76 #define AMS_EXTENDED 0x1
77 #define AMS_TOUCHPAD 0x2
91 size_t packet_read_len;
97 static device_method_t adb_mouse_methods[] = {
98 /* Device interface */
99 DEVMETHOD(device_probe, adb_mouse_probe),
100 DEVMETHOD(device_attach, adb_mouse_attach),
101 DEVMETHOD(device_detach, adb_mouse_detach),
102 DEVMETHOD(device_shutdown, bus_generic_shutdown),
103 DEVMETHOD(device_suspend, bus_generic_suspend),
104 DEVMETHOD(device_resume, bus_generic_resume),
107 DEVMETHOD(adb_receive_packet, adb_mouse_receive_packet),
112 static driver_t adb_mouse_driver = {
115 sizeof(struct adb_mouse_softc),
118 static devclass_t adb_mouse_devclass;
120 DRIVER_MODULE(ams, adb, adb_mouse_driver, adb_mouse_devclass, 0, 0);
122 static struct cdevsw ams_cdevsw = {
123 .d_version = D_VERSION,
126 .d_close = ams_close,
128 .d_ioctl = ams_ioctl,
134 adb_mouse_probe(device_t dev)
138 type = adb_get_device_type(dev);
140 if (type != ADB_DEVICE_MOUSE)
143 device_set_desc(dev,"ADB Mouse");
148 adb_mouse_attach(device_t dev)
150 struct adb_mouse_softc *sc;
151 char *description = "Unknown Pointing Device";
156 sc = device_get_softc(dev);
159 mtx_init(&sc->sc_mtx, "ams", NULL, MTX_DEF);
160 cv_init(&sc->sc_cv,"ams");
165 sc->hw.iftype = MOUSE_IF_UNKNOWN;
166 sc->hw.type = MOUSE_UNKNOWN;
167 sc->hw.model = sc->hw.hwid = 0;
169 sc->mode.protocol = MOUSE_PROTO_SYSMOUSE;
171 sc->mode.resolution = 100;
172 sc->mode.accelfactor = 0;
174 sc->mode.packetsize = 5;
179 sc->last_buttons = 0;
180 sc->packet_read_len = 0;
182 /* Try to switch to extended protocol */
183 adb_set_device_handler(dev,4);
185 switch(adb_get_device_handler(dev)) {
187 sc->mode.resolution = 100;
190 sc->mode.resolution = 200;
193 r1_len = adb_read_register(dev,1,r1);
197 sc->flags |= AMS_EXTENDED;
198 memcpy(&sc->hw.hwid,r1,4);
199 sc->mode.resolution = (r1[4] << 8) | r1[5];
203 sc->hw.type = MOUSE_PAD;
204 description = "Tablet";
207 sc->hw.type = MOUSE_MOUSE;
208 description = "Mouse";
211 sc->hw.type = MOUSE_TRACKBALL;
212 description = "Trackball";
215 sc->flags |= AMS_TOUCHPAD;
216 sc->hw.type = MOUSE_PAD;
217 adb_init_trackpad(dev);
218 description = "Touchpad";
222 sc->hw.buttons = r1[7];
224 device_printf(dev,"%d-button %d-dpi %s\n",
225 sc->hw.buttons, sc->mode.resolution,description);
228 * Check for one of MacAlly's non-compliant 2-button mice.
229 * These claim to speak the extended mouse protocol, but
230 * instead speak the standard protocol and only when their
231 * handler is set to 0x42.
234 if (sc->hw.hwid == 0x4b4f4954) {
235 adb_set_device_handler(dev,0x42);
237 if (adb_get_device_handler(dev) == 0x42) {
238 device_printf(dev, "MacAlly 2-Button Mouse\n");
239 sc->flags &= ~AMS_EXTENDED;
246 sc->cdev = make_dev(&ams_cdevsw, device_get_unit(dev),
247 UID_ROOT, GID_OPERATOR, 0644, "ams%d",
248 device_get_unit(dev));
249 sc->cdev->si_drv1 = sc;
251 adb_set_autopoll(dev,1);
257 adb_mouse_detach(device_t dev)
259 struct adb_mouse_softc *sc;
261 adb_set_autopoll(dev,0);
263 sc = device_get_softc(dev);
264 destroy_dev(sc->cdev);
266 mtx_destroy(&sc->sc_mtx);
267 cv_destroy(&sc->sc_cv);
273 adb_init_trackpad(device_t dev)
275 struct adb_mouse_softc *sc;
276 struct sysctl_ctx_list *ctx;
277 struct sysctl_oid *tree;
283 sc = device_get_softc(dev);
285 r1_len = adb_read_register(dev, 1, r1);
287 /* An Extended Mouse register1 must return 8 bytes. */
295 adb_write_register(dev, 1, 8, r1);
297 r1_len = adb_read_register(dev, 1, r1);
301 device_printf(dev, "ADB Mouse = 0x%x "
302 "(non-Extended Mode)\n", r1[6]);
305 device_printf(dev, "ADB Mouse = 0x%x "
306 "(Extended Mode)\n", r1[6]);
308 /* Set ADB Extended Features to default values,
310 r2[0] = 0x19; /* Clicking: 0x19 disabled 0x99 enabled */
311 r2[1] = 0x94; /* Dragging: 0x14 disabled 0x94 enabled */
313 r2[3] = 0xff; /* DragLock: 0xff disabled 0xb2 enabled */
318 r2[7] = 0x57; /* 0x57 bits 3:0 for W mode */
320 adb_write_register(dev, 2, 8, r2);
328 ctx = device_get_sysctl_ctx(dev);
329 tree = device_get_sysctl_tree(dev);
330 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, "tapping",
331 CTLTYPE_INT | CTLFLAG_RW, sc, 0, adb_tapping_sysctl,
332 "I", "Tapping the pad causes button events");
337 adb_mouse_receive_packet(device_t dev, u_char status, u_char command,
338 u_char reg, int len, u_char *data)
340 struct adb_mouse_softc *sc;
343 int buttons, tmp_buttons;
345 sc = device_get_softc(dev);
347 if (command != ADB_COMMAND_TALK || reg != 0 || len < 2)
350 ydelta = data[0] & 0x7f;
351 xdelta = data[1] & 0x7f;
354 buttons |= !(data[0] & 0x80);
355 buttons |= !(data[1] & 0x80) << 1;
357 if (sc->flags & AMS_EXTENDED) {
358 for (i = 2; i < len && i < 5; i++) {
359 xdelta |= (data[i] & 0x07) << (3*i + 1);
360 ydelta |= (data[i] & 0x70) << (3*i - 3);
362 buttons |= !(data[i] & 0x08) << (2*i - 2);
363 buttons |= !(data[i] & 0x80) << (2*i - 1);
366 len = 2; /* Ignore extra data */
369 /* Do sign extension as necessary */
370 if (xdelta & (0x40 << 3*(len-2)))
371 xdelta |= 0xffffffc0 << 3*(len - 2);
372 if (ydelta & (0x40 << 3*(len-2)))
373 ydelta |= 0xffffffc0 << 3*(len - 2);
375 if ((sc->flags & AMS_TOUCHPAD) && (sc->sc_tapping == 1)) {
376 tmp_buttons = buttons;
377 if (buttons == 0x12) {
378 /* Map a double tap on button 3.
379 Keep the button state for the next sequence.
380 A double tap sequence is followed by a single tap
384 sc->button_buf = tmp_buttons;
385 } else if (buttons == 0x2) {
386 /* Map a single tap on button 2. But only if it is
387 not a successor from a double tap.
389 if (sc->button_buf != 0x3)
396 buttons = tmp_buttons;
400 * Some mice report high-numbered buttons on the wrong button number,
401 * so set the highest-numbered real button as pressed if there are
402 * mysterious high-numbered ones set.
404 * Don't do this for touchpads, because touchpads also trigger
405 * high button events when they are touched.
408 if (rounddown2(buttons, 1 << sc->hw.buttons)
409 && !(sc->flags & AMS_TOUCHPAD)) {
410 buttons |= 1 << (sc->hw.buttons - 1);
412 buttons &= (1 << sc->hw.buttons) - 1;
414 mtx_lock(&sc->sc_mtx);
416 /* Add in our new deltas, and take into account
417 Apple's opposite meaning for Y axis motion */
419 sc->xdelta += xdelta;
420 sc->ydelta -= ydelta;
422 sc->buttons = buttons;
424 mtx_unlock(&sc->sc_mtx);
426 cv_broadcast(&sc->sc_cv);
427 selwakeuppri(&sc->rsel, PZERO);
433 ams_open(struct cdev *dev, int flag, int fmt, struct thread *p)
435 struct adb_mouse_softc *sc;
437 sc = CDEV_GET_SOFTC(dev);
441 mtx_lock(&sc->sc_mtx);
442 sc->packet_read_len = 0;
446 mtx_unlock(&sc->sc_mtx);
452 ams_close(struct cdev *dev, int flag, int fmt, struct thread *p)
454 struct adb_mouse_softc *sc;
456 sc = CDEV_GET_SOFTC(dev);
458 cv_broadcast(&sc->sc_cv);
459 selwakeuppri(&sc->rsel, PZERO);
464 ams_poll(struct cdev *dev, int events, struct thread *p)
466 struct adb_mouse_softc *sc;
468 sc = CDEV_GET_SOFTC(dev);
472 if (events & (POLLIN | POLLRDNORM)) {
473 mtx_lock(&sc->sc_mtx);
475 if (sc->xdelta == 0 && sc->ydelta == 0 &&
476 sc->buttons == sc->last_buttons &&
477 sc->packet_read_len == 0) {
478 selrecord(p, &sc->rsel);
481 events &= (POLLIN | POLLRDNORM);
484 mtx_unlock(&sc->sc_mtx);
491 ams_read(struct cdev *dev, struct uio *uio, int flag)
493 struct adb_mouse_softc *sc;
498 sc = CDEV_GET_SOFTC(dev);
502 if (uio->uio_resid <= 0)
505 mtx_lock(&sc->sc_mtx);
507 if (!sc->packet_read_len) {
508 if (sc->xdelta == 0 && sc->ydelta == 0 &&
509 sc->buttons == sc->last_buttons) {
511 if (flag & O_NONBLOCK) {
512 mtx_unlock(&sc->sc_mtx);
517 /* Otherwise, block on new data */
518 error = cv_wait_sig(&sc->sc_cv, &sc->sc_mtx);
520 mtx_unlock(&sc->sc_mtx);
525 sc->packet[0] = 1U << 7;
526 sc->packet[0] |= (!(sc->buttons & 1)) << 2;
527 sc->packet[0] |= (!(sc->buttons & 4)) << 1;
528 sc->packet[0] |= (!(sc->buttons & 2));
530 if (sc->xdelta > 127) {
532 sc->packet[3] = sc->xdelta - 127;
533 } else if (sc->xdelta < -127) {
534 sc->packet[1] = -127;
535 sc->packet[3] = sc->xdelta + 127;
537 sc->packet[1] = sc->xdelta;
541 if (sc->ydelta > 127) {
543 sc->packet[4] = sc->ydelta - 127;
544 } else if (sc->ydelta < -127) {
545 sc->packet[2] = -127;
546 sc->packet[4] = sc->ydelta + 127;
548 sc->packet[2] = sc->ydelta;
556 sc->packet[7] = ~((uint8_t)(sc->buttons >> 3)) & 0x7f;
559 sc->last_buttons = sc->buttons;
563 sc->packet_read_len = sc->mode.packetsize;
566 len = (sc->packet_read_len > uio->uio_resid) ?
567 uio->uio_resid : sc->packet_read_len;
569 memcpy(outpacket,sc->packet +
570 (sc->mode.packetsize - sc->packet_read_len),len);
571 sc->packet_read_len -= len;
573 mtx_unlock(&sc->sc_mtx);
575 error = uiomove(outpacket,len,uio);
582 ams_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
585 struct adb_mouse_softc *sc;
588 sc = CDEV_GET_SOFTC(dev);
593 case MOUSE_GETHWINFO:
594 *(mousehw_t *)addr = sc->hw;
597 *(mousemode_t *)addr = sc->mode;
600 mode = *(mousemode_t *)addr;
601 addr = (caddr_t)&mode.level;
606 if (*(int *)addr == -1)
608 else if (*(int *)addr == 1) {
610 sc->mode.packetsize = 8;
612 } else if (*(int *)addr == 0) {
614 sc->mode.packetsize = 5;
620 *(int *)addr = sc->mode.level;
623 case MOUSE_GETSTATUS: {
624 mousestatus_t *status = (mousestatus_t *) addr;
626 mtx_lock(&sc->sc_mtx);
628 status->button = sc->buttons;
629 status->obutton = sc->last_buttons;
631 status->flags = status->button ^ status->obutton;
633 if (sc->xdelta != 0 || sc->ydelta)
634 status->flags |= MOUSE_POSCHANGED;
635 if (status->button != status->obutton)
636 status->flags |= MOUSE_BUTTONSCHANGED;
638 status->dx = sc->xdelta;
639 status->dy = sc->ydelta;
644 sc->last_buttons = sc->buttons;
646 mtx_unlock(&sc->sc_mtx);
657 adb_tapping_sysctl(SYSCTL_HANDLER_ARGS)
659 struct adb_mouse_softc *sc = arg1;
666 tapping = sc->sc_tapping;
668 error = sysctl_handle_int(oidp, &tapping, 0, req);
670 if (error || !req->newptr)
674 adb_read_register(dev, 2, r2);
675 r2[0] = 0x99; /* enable tapping. */
676 adb_write_register(dev, 2, 8, r2);
678 } else if (tapping == 0) {
679 adb_read_register(dev, 2, r2);
680 r2[0] = 0x19; /* disable tapping. */
681 adb_write_register(dev, 2, 8, r2);