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>
34 #include <sys/module.h>
35 #include <sys/mutex.h>
38 #include <sys/mouse.h>
40 #include <sys/condvar.h>
41 #include <sys/selinfo.h>
42 #include <sys/sysctl.h>
44 #include <sys/fcntl.h>
45 #include <sys/kernel.h>
47 #include <machine/bus.h>
54 #define CDEV_GET_SOFTC(x) (x)->si_drv1
56 static int adb_mouse_probe(device_t dev);
57 static int adb_mouse_attach(device_t dev);
58 static int adb_mouse_detach(device_t dev);
59 static void adb_init_trackpad(device_t dev);
60 static int adb_tapping_sysctl(SYSCTL_HANDLER_ARGS);
62 static d_open_t ams_open;
63 static d_close_t ams_close;
64 static d_read_t ams_read;
65 static d_ioctl_t ams_ioctl;
66 static d_poll_t ams_poll;
68 static u_int adb_mouse_receive_packet(device_t dev, u_char status,
69 u_char command, u_char reg, int len, u_char *data);
71 struct adb_mouse_softc {
78 #define AMS_EXTENDED 0x1
79 #define AMS_TOUCHPAD 0x2
93 size_t packet_read_len;
99 static device_method_t adb_mouse_methods[] = {
100 /* Device interface */
101 DEVMETHOD(device_probe, adb_mouse_probe),
102 DEVMETHOD(device_attach, adb_mouse_attach),
103 DEVMETHOD(device_detach, adb_mouse_detach),
104 DEVMETHOD(device_shutdown, bus_generic_shutdown),
105 DEVMETHOD(device_suspend, bus_generic_suspend),
106 DEVMETHOD(device_resume, bus_generic_resume),
109 DEVMETHOD(adb_receive_packet, adb_mouse_receive_packet),
113 static driver_t adb_mouse_driver = {
116 sizeof(struct adb_mouse_softc),
119 static devclass_t adb_mouse_devclass;
121 DRIVER_MODULE(ams, adb, adb_mouse_driver, adb_mouse_devclass, 0, 0);
123 static struct cdevsw ams_cdevsw = {
124 .d_version = D_VERSION,
127 .d_close = ams_close,
129 .d_ioctl = ams_ioctl,
135 adb_mouse_probe(device_t dev)
139 type = adb_get_device_type(dev);
141 if (type != ADB_DEVICE_MOUSE)
144 device_set_desc(dev,"ADB Mouse");
149 adb_mouse_attach(device_t dev)
151 struct adb_mouse_softc *sc;
152 char *description = "Unknown Pointing Device";
157 sc = device_get_softc(dev);
160 mtx_init(&sc->sc_mtx, "ams", NULL, MTX_DEF);
161 cv_init(&sc->sc_cv,"ams");
166 sc->hw.iftype = MOUSE_IF_UNKNOWN;
167 sc->hw.type = MOUSE_UNKNOWN;
168 sc->hw.model = sc->hw.hwid = 0;
170 sc->mode.protocol = MOUSE_PROTO_SYSMOUSE;
172 sc->mode.resolution = 100;
173 sc->mode.accelfactor = 0;
175 sc->mode.packetsize = 5;
180 sc->last_buttons = 0;
181 sc->packet_read_len = 0;
183 /* Try to switch to extended protocol */
184 adb_set_device_handler(dev,4);
186 switch(adb_get_device_handler(dev)) {
188 sc->mode.resolution = 100;
191 sc->mode.resolution = 200;
194 r1_len = adb_read_register(dev,1,r1);
198 sc->flags |= AMS_EXTENDED;
199 memcpy(&sc->hw.hwid,r1,4);
200 sc->mode.resolution = (r1[4] << 8) | r1[5];
204 sc->hw.type = MOUSE_PAD;
205 description = "Tablet";
208 sc->hw.type = MOUSE_MOUSE;
209 description = "Mouse";
212 sc->hw.type = MOUSE_TRACKBALL;
213 description = "Trackball";
216 sc->flags |= AMS_TOUCHPAD;
217 sc->hw.type = MOUSE_PAD;
218 adb_init_trackpad(dev);
219 description = "Touchpad";
223 sc->hw.buttons = r1[7];
225 device_printf(dev,"%d-button %d-dpi %s\n",
226 sc->hw.buttons, sc->mode.resolution,description);
229 * Check for one of MacAlly's non-compliant 2-button mice.
230 * These claim to speak the extended mouse protocol, but
231 * instead speak the standard protocol and only when their
232 * handler is set to 0x42.
235 if (sc->hw.hwid == 0x4b4f4954) {
236 adb_set_device_handler(dev,0x42);
238 if (adb_get_device_handler(dev) == 0x42) {
239 device_printf(dev, "MacAlly 2-Button Mouse\n");
240 sc->flags &= ~AMS_EXTENDED;
247 sc->cdev = make_dev(&ams_cdevsw, device_get_unit(dev),
248 UID_ROOT, GID_OPERATOR, 0644, "ams%d",
249 device_get_unit(dev));
250 sc->cdev->si_drv1 = sc;
252 adb_set_autopoll(dev,1);
258 adb_mouse_detach(device_t dev)
260 struct adb_mouse_softc *sc;
262 adb_set_autopoll(dev,0);
264 sc = device_get_softc(dev);
265 destroy_dev(sc->cdev);
267 mtx_destroy(&sc->sc_mtx);
268 cv_destroy(&sc->sc_cv);
274 adb_init_trackpad(device_t dev)
276 struct adb_mouse_softc *sc;
277 struct sysctl_ctx_list *ctx;
278 struct sysctl_oid *tree;
284 sc = device_get_softc(dev);
286 r1_len = adb_read_register(dev, 1, r1);
288 /* An Extended Mouse register1 must return 8 bytes. */
296 adb_write_register(dev, 1, 8, r1);
298 r1_len = adb_read_register(dev, 1, r1);
302 device_printf(dev, "ADB Mouse = 0x%x "
303 "(non-Extended Mode)\n", r1[6]);
306 device_printf(dev, "ADB Mouse = 0x%x "
307 "(Extended Mode)\n", r1[6]);
309 /* Set ADB Extended Features to default values,
311 r2[0] = 0x19; /* Clicking: 0x19 disabled 0x99 enabled */
312 r2[1] = 0x94; /* Dragging: 0x14 disabled 0x94 enabled */
314 r2[3] = 0xff; /* DragLock: 0xff disabled 0xb2 enabled */
319 r2[7] = 0x57; /* 0x57 bits 3:0 for W mode */
321 adb_write_register(dev, 2, 8, r2);
329 ctx = device_get_sysctl_ctx(dev);
330 tree = device_get_sysctl_tree(dev);
331 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, "tapping",
332 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, sc, 0,
333 adb_tapping_sysctl, "I", "Tapping the pad causes button events");
338 adb_mouse_receive_packet(device_t dev, u_char status, u_char command,
339 u_char reg, int len, u_char *data)
341 struct adb_mouse_softc *sc;
344 int buttons, tmp_buttons;
346 sc = device_get_softc(dev);
348 if (command != ADB_COMMAND_TALK || reg != 0 || len < 2)
351 ydelta = data[0] & 0x7f;
352 xdelta = data[1] & 0x7f;
355 buttons |= !(data[0] & 0x80);
356 buttons |= !(data[1] & 0x80) << 1;
358 if (sc->flags & AMS_EXTENDED) {
359 for (i = 2; i < len && i < 5; i++) {
360 xdelta |= (data[i] & 0x07) << (3*i + 1);
361 ydelta |= (data[i] & 0x70) << (3*i - 3);
363 buttons |= !(data[i] & 0x08) << (2*i - 2);
364 buttons |= !(data[i] & 0x80) << (2*i - 1);
367 len = 2; /* Ignore extra data */
370 /* Do sign extension as necessary */
371 if (xdelta & (0x40 << 3*(len-2)))
372 xdelta |= 0xffffffc0 << 3*(len - 2);
373 if (ydelta & (0x40 << 3*(len-2)))
374 ydelta |= 0xffffffc0 << 3*(len - 2);
376 if ((sc->flags & AMS_TOUCHPAD) && (sc->sc_tapping == 1)) {
377 tmp_buttons = buttons;
378 if (buttons == 0x12) {
379 /* Map a double tap on button 3.
380 Keep the button state for the next sequence.
381 A double tap sequence is followed by a single tap
385 sc->button_buf = tmp_buttons;
386 } else if (buttons == 0x2) {
387 /* Map a single tap on button 2. But only if it is
388 not a successor from a double tap.
390 if (sc->button_buf != 0x3)
397 buttons = tmp_buttons;
401 * Some mice report high-numbered buttons on the wrong button number,
402 * so set the highest-numbered real button as pressed if there are
403 * mysterious high-numbered ones set.
405 * Don't do this for touchpads, because touchpads also trigger
406 * high button events when they are touched.
409 if (rounddown2(buttons, 1 << sc->hw.buttons)
410 && !(sc->flags & AMS_TOUCHPAD)) {
411 buttons |= 1 << (sc->hw.buttons - 1);
413 buttons &= (1 << sc->hw.buttons) - 1;
415 mtx_lock(&sc->sc_mtx);
417 /* Add in our new deltas, and take into account
418 Apple's opposite meaning for Y axis motion */
420 sc->xdelta += xdelta;
421 sc->ydelta -= ydelta;
423 sc->buttons = buttons;
425 mtx_unlock(&sc->sc_mtx);
427 cv_broadcast(&sc->sc_cv);
428 selwakeuppri(&sc->rsel, PZERO);
434 ams_open(struct cdev *dev, int flag, int fmt, struct thread *p)
436 struct adb_mouse_softc *sc;
438 sc = CDEV_GET_SOFTC(dev);
442 mtx_lock(&sc->sc_mtx);
443 sc->packet_read_len = 0;
447 mtx_unlock(&sc->sc_mtx);
453 ams_close(struct cdev *dev, int flag, int fmt, struct thread *p)
455 struct adb_mouse_softc *sc;
457 sc = CDEV_GET_SOFTC(dev);
459 cv_broadcast(&sc->sc_cv);
460 selwakeuppri(&sc->rsel, PZERO);
465 ams_poll(struct cdev *dev, int events, struct thread *p)
467 struct adb_mouse_softc *sc;
469 sc = CDEV_GET_SOFTC(dev);
473 if (events & (POLLIN | POLLRDNORM)) {
474 mtx_lock(&sc->sc_mtx);
476 if (sc->xdelta == 0 && sc->ydelta == 0 &&
477 sc->buttons == sc->last_buttons &&
478 sc->packet_read_len == 0) {
479 selrecord(p, &sc->rsel);
482 events &= (POLLIN | POLLRDNORM);
485 mtx_unlock(&sc->sc_mtx);
492 ams_read(struct cdev *dev, struct uio *uio, int flag)
494 struct adb_mouse_softc *sc;
499 sc = CDEV_GET_SOFTC(dev);
503 if (uio->uio_resid <= 0)
506 mtx_lock(&sc->sc_mtx);
508 if (!sc->packet_read_len) {
509 if (sc->xdelta == 0 && sc->ydelta == 0 &&
510 sc->buttons == sc->last_buttons) {
511 if (flag & O_NONBLOCK) {
512 mtx_unlock(&sc->sc_mtx);
516 /* Otherwise, block on new data */
517 error = cv_wait_sig(&sc->sc_cv, &sc->sc_mtx);
519 mtx_unlock(&sc->sc_mtx);
524 sc->packet[0] = 1U << 7;
525 sc->packet[0] |= (!(sc->buttons & 1)) << 2;
526 sc->packet[0] |= (!(sc->buttons & 4)) << 1;
527 sc->packet[0] |= (!(sc->buttons & 2));
529 if (sc->xdelta > 127) {
531 sc->packet[3] = sc->xdelta - 127;
532 } else if (sc->xdelta < -127) {
533 sc->packet[1] = -127;
534 sc->packet[3] = sc->xdelta + 127;
536 sc->packet[1] = sc->xdelta;
540 if (sc->ydelta > 127) {
542 sc->packet[4] = sc->ydelta - 127;
543 } else if (sc->ydelta < -127) {
544 sc->packet[2] = -127;
545 sc->packet[4] = sc->ydelta + 127;
547 sc->packet[2] = sc->ydelta;
555 sc->packet[7] = ~((uint8_t)(sc->buttons >> 3)) & 0x7f;
557 sc->last_buttons = sc->buttons;
561 sc->packet_read_len = sc->mode.packetsize;
564 len = (sc->packet_read_len > uio->uio_resid) ?
565 uio->uio_resid : sc->packet_read_len;
567 memcpy(outpacket,sc->packet +
568 (sc->mode.packetsize - sc->packet_read_len),len);
569 sc->packet_read_len -= len;
571 mtx_unlock(&sc->sc_mtx);
573 error = uiomove(outpacket,len,uio);
579 ams_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
582 struct adb_mouse_softc *sc;
585 sc = CDEV_GET_SOFTC(dev);
590 case MOUSE_GETHWINFO:
591 *(mousehw_t *)addr = sc->hw;
594 *(mousemode_t *)addr = sc->mode;
597 mode = *(mousemode_t *)addr;
598 addr = (caddr_t)&mode.level;
603 if (*(int *)addr == -1)
605 else if (*(int *)addr == 1) {
607 sc->mode.packetsize = 8;
609 } else if (*(int *)addr == 0) {
611 sc->mode.packetsize = 5;
617 *(int *)addr = sc->mode.level;
620 case MOUSE_GETSTATUS: {
621 mousestatus_t *status = (mousestatus_t *) addr;
623 mtx_lock(&sc->sc_mtx);
625 status->button = sc->buttons;
626 status->obutton = sc->last_buttons;
628 status->flags = status->button ^ status->obutton;
630 if (sc->xdelta != 0 || sc->ydelta)
631 status->flags |= MOUSE_POSCHANGED;
632 if (status->button != status->obutton)
633 status->flags |= MOUSE_BUTTONSCHANGED;
635 status->dx = sc->xdelta;
636 status->dy = sc->ydelta;
641 sc->last_buttons = sc->buttons;
643 mtx_unlock(&sc->sc_mtx);
653 adb_tapping_sysctl(SYSCTL_HANDLER_ARGS)
655 struct adb_mouse_softc *sc = arg1;
662 tapping = sc->sc_tapping;
664 error = sysctl_handle_int(oidp, &tapping, 0, req);
666 if (error || !req->newptr)
670 adb_read_register(dev, 2, r2);
671 r2[0] = 0x99; /* enable tapping. */
672 adb_write_register(dev, 2, 8, r2);
674 } else if (tapping == 0) {
675 adb_read_register(dev, 2, r2);
676 r2[0] = 0x19; /* disable tapping. */
677 adb_write_register(dev, 2, 8, r2);