1 /* $OpenBSD: ikbd.c,v 1.3 2025/01/07 19:26:14 mglocker Exp $ */ 2 /* 3 * HID-over-i2c keyboard driver 4 * 5 * Copyright (c) 2016 Mark Kettenis <kettenis@openbsd.org> 6 * 7 * Permission to use, copy, modify, and distribute this software for any 8 * purpose with or without fee is hereby granted, provided that the above 9 * copyright notice and this permission notice appear in all copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18 */ 19 20 #include <sys/param.h> 21 #include <sys/systm.h> 22 #include <sys/kernel.h> 23 #include <sys/device.h> 24 #include <sys/ioctl.h> 25 #include <sys/timeout.h> 26 27 #include <dev/i2c/i2cvar.h> 28 #include <dev/i2c/ihidev.h> 29 30 #include <dev/wscons/wsconsio.h> 31 #include <dev/wscons/wskbdvar.h> 32 #include <dev/wscons/wsksymdef.h> 33 34 #include <dev/hid/hid.h> 35 #include <dev/hid/hidkbdsc.h> 36 37 struct ikbd_softc { 38 struct ihidev sc_hdev; 39 #define sc_ledsize sc_hdev.sc_osize 40 struct hidkbd sc_kbd; 41 int sc_spl; 42 }; 43 44 void ikbd_intr(struct ihidev *addr, void *ibuf, u_int len); 45 46 void ikbd_cngetc(void *, u_int *, int *); 47 void ikbd_cnpollc(void *, int); 48 void ikbd_cnbell(void *, u_int, u_int, u_int); 49 50 const struct wskbd_consops ikbd_consops = { 51 ikbd_cngetc, 52 ikbd_cnpollc, 53 ikbd_cnbell, 54 }; 55 56 int ikbd_enable(void *, int); 57 void ikbd_set_leds(void *, int); 58 int ikbd_ioctl(void *, u_long, caddr_t, int, struct proc *); 59 60 const struct wskbd_accessops ikbd_accessops = { 61 ikbd_enable, 62 ikbd_set_leds, 63 ikbd_ioctl, 64 }; 65 66 int ikbd_match(struct device *, void *, void *); 67 void ikbd_attach(struct device *, struct device *, void *); 68 int ikbd_detach(struct device *, int); 69 70 struct cfdriver ikbd_cd = { 71 NULL, "ikbd", DV_DULL 72 }; 73 74 const struct cfattach ikbd_ca = { 75 sizeof(struct ikbd_softc), 76 ikbd_match, 77 ikbd_attach, 78 ikbd_detach 79 }; 80 81 int 82 ikbd_match(struct device *parent, void *match, void *aux) 83 { 84 struct ihidev_attach_arg *iha = (struct ihidev_attach_arg *)aux; 85 int size; 86 void *desc; 87 88 ihidev_get_report_desc(iha->parent, &desc, &size); 89 if (!hid_is_collection(desc, size, iha->reportid, 90 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_KEYBOARD))) 91 return (IMATCH_NONE); 92 93 return (IMATCH_IFACECLASS); 94 } 95 96 void 97 ikbd_attach(struct device *parent, struct device *self, void *aux) 98 { 99 struct ikbd_softc *sc = (struct ikbd_softc *)self; 100 struct hidkbd *kbd = &sc->sc_kbd; 101 struct ihidev_attach_arg *iha = (struct ihidev_attach_arg *)aux; 102 int dlen, repid; 103 void *desc; 104 105 sc->sc_hdev.sc_intr = ikbd_intr; 106 sc->sc_hdev.sc_parent = iha->parent; 107 sc->sc_hdev.sc_report_id = iha->reportid; 108 109 ihidev_get_report_desc(iha->parent, &desc, &dlen); 110 repid = iha->reportid; 111 sc->sc_hdev.sc_isize = hid_report_size(desc, dlen, hid_input, repid); 112 sc->sc_hdev.sc_osize = hid_report_size(desc, dlen, hid_output, repid); 113 sc->sc_hdev.sc_fsize = hid_report_size(desc, dlen, hid_feature, repid); 114 115 if (hidkbd_attach(self, kbd, 1, 0, repid, desc, dlen) != 0) 116 return; 117 118 printf("\n"); 119 120 if (kbd->sc_console_keyboard) { 121 extern struct wskbd_mapdata ukbd_keymapdata; 122 123 ukbd_keymapdata.layout = KB_US | KB_DEFAULT; 124 wskbd_cnattach(&ikbd_consops, sc, &ukbd_keymapdata); 125 ikbd_enable(sc, 1); 126 } 127 128 hidkbd_attach_wskbd(kbd, KB_US | KB_DEFAULT, &ikbd_accessops); 129 } 130 131 int 132 ikbd_detach(struct device *self, int flags) 133 { 134 struct ikbd_softc *sc = (struct ikbd_softc *)self; 135 struct hidkbd *kbd = &sc->sc_kbd; 136 137 return hidkbd_detach(kbd, flags); 138 } 139 140 void 141 ikbd_intr(struct ihidev *addr, void *ibuf, u_int len) 142 { 143 struct ikbd_softc *sc = (struct ikbd_softc *)addr; 144 struct hidkbd *kbd = &sc->sc_kbd; 145 146 if (kbd->sc_enabled != 0) 147 hidkbd_input(kbd, (uint8_t *)ibuf, len); 148 } 149 150 int 151 ikbd_enable(void *v, int on) 152 { 153 struct ikbd_softc *sc = v; 154 struct hidkbd *kbd = &sc->sc_kbd; 155 int rv; 156 157 if ((rv = hidkbd_enable(kbd, on)) != 0) 158 return rv; 159 160 if (on) { 161 return ihidev_open(&sc->sc_hdev); 162 } else { 163 ihidev_close(&sc->sc_hdev); 164 return 0; 165 } 166 } 167 168 void 169 ikbd_set_leds(void *v, int leds) 170 { 171 struct ikbd_softc *sc = v; 172 struct hidkbd *kbd = &sc->sc_kbd; 173 uint8_t res; 174 175 if (sc->sc_ledsize && hidkbd_set_leds(kbd, leds, &res) != 0) { 176 ihidev_send_report((struct device *)sc->sc_hdev.sc_parent, 177 sc->sc_hdev.sc_report_id, &res, 1); 178 } 179 } 180 181 int 182 ikbd_ioctl(void *v, u_long cmd, caddr_t data, int flag, struct proc *p) 183 { 184 struct ikbd_softc *sc = v; 185 struct hidkbd *kbd = &sc->sc_kbd; 186 int rc; 187 188 switch (cmd) { 189 case WSKBDIO_GTYPE: 190 /* XXX: should we set something else? */ 191 *(u_int *)data = WSKBD_TYPE_USB; 192 return 0; 193 case WSKBDIO_SETLEDS: 194 ikbd_set_leds(v, *(int *)data); 195 return 0; 196 default: 197 rc = ihidev_ioctl(&sc->sc_hdev, cmd, data, flag, p); 198 if (rc != -1) 199 return rc; 200 else 201 return hidkbd_ioctl(kbd, cmd, data, flag, p); 202 } 203 } 204 205 /* Console interface. */ 206 void 207 ikbd_cngetc(void *v, u_int *type, int *data) 208 { 209 struct ikbd_softc *sc = v; 210 struct hidkbd *kbd = &sc->sc_kbd; 211 212 kbd->sc_polling = 1; 213 while (kbd->sc_npollchar <= 0) { 214 ihidev_poll(sc->sc_hdev.sc_parent); 215 delay(1000); 216 } 217 kbd->sc_polling = 0; 218 hidkbd_cngetc(kbd, type, data); 219 } 220 221 void 222 ikbd_cnpollc(void *v, int on) 223 { 224 struct ikbd_softc *sc = v; 225 226 if (on) 227 sc->sc_spl = spltty(); 228 else 229 splx(sc->sc_spl); 230 } 231 232 void 233 ikbd_cnbell(void *v, u_int pitch, u_int period, u_int volume) 234 { 235 hidkbd_bell(pitch, period, volume, 1); 236 } 237