tcakp.c revision 1.13
1 /* $NetBSD: tcakp.c,v 1.13 2021/01/17 21:42:35 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 2017 Jared McNeill <jmcneill (at) invisible.ca> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 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. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #include "opt_fdt.h" 30 31 #include <sys/cdefs.h> 32 __KERNEL_RCSID(0, "$NetBSD: tcakp.c,v 1.13 2021/01/17 21:42:35 thorpej Exp $"); 33 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/kernel.h> 37 #include <sys/device.h> 38 #include <sys/conf.h> 39 #include <sys/bus.h> 40 #include <sys/kmem.h> 41 #include <sys/bitops.h> 42 43 #include <dev/i2c/i2cvar.h> 44 45 #include <dev/wscons/wsconsio.h> 46 #include <dev/wscons/wskbdvar.h> 47 #include <dev/wscons/wsksymdef.h> 48 #include <dev/wscons/wsksymvar.h> 49 #include <dev/wscons/linux_keymap.h> 50 51 #ifdef FDT 52 #include <dev/fdt/fdtvar.h> 53 #endif 54 55 #define TCA_MAX_ROWS 8 56 #define TCA_MAX_COLS 10 57 58 #define TCA_CFG 0x01 59 #define CFG_AI __BIT(7) 60 #define CFG_GPI_E_CFG __BIT(6) 61 #define CFG_OVR_FLOW_M __BIT(5) 62 #define CFG_INT_CFG __BIT(4) 63 #define CFG_OVR_FLOW_IEN __BIT(3) 64 #define CFG_K_LCK_IEN __BIT(2) 65 #define CFG_GPI_IEN __BIT(1) 66 #define CFG_KE_IEN __BIT(0) 67 #define TCA_INT_STAT 0x02 68 #define INT_STAT_CAD_INT __BIT(4) 69 #define INT_STAT_OVR_FLOW_INT __BIT(3) 70 #define INT_STAT_K_LCD_INT __BIT(2) 71 #define INT_STAT_GPI_INT __BIT(1) 72 #define INT_STAT_K_INT __BIT(0) 73 #define TCA_KEY_LCK_EC 0x03 74 #define KEY_LCK_EC_K_LCK_EN __BIT(6) 75 #define KEY_LCK_EC_LCK2 __BIT(5) 76 #define KEY_LCK_EC_LCK1 __BIT(4) 77 #define KEY_LCK_EC_KEC __BITS(3,0) 78 #define TCA_EVENT(c) (0x04 + (c) - 'A') 79 #define TCA_EVENT_STATE __BIT(7) 80 #define TCA_EVENT_CODE __BITS(6,0) 81 #define TCA_KP_GPIO1 0x1d 82 #define TCA_KP_GPIO2 0x1e 83 #define TCA_KP_GPIO3 0x1f 84 #define TCA_DEBOUNCE_DIS1 0x29 85 #define TCA_DEBOUNCE_DIS2 0x2a 86 #define TCA_DEBOUNCE_DIS3 0x2b 87 88 struct tcakp_softc { 89 device_t sc_dev; 90 i2c_tag_t sc_i2c; 91 i2c_addr_t sc_addr; 92 int sc_phandle; 93 94 u_int sc_rows; 95 u_int sc_cols; 96 bool sc_autorepeat; 97 u_int sc_row_shift; 98 99 uint16_t sc_keymap[128]; 100 101 void *sc_ih; 102 void *sc_sih; 103 104 int sc_enabled; 105 device_t sc_wskbddev; 106 }; 107 108 static int tcakp_match(device_t, cfdata_t, void *); 109 static void tcakp_attach(device_t, device_t, void *); 110 111 static int tcakp_i2c_lock(struct tcakp_softc *); 112 static void tcakp_i2c_unlock(struct tcakp_softc *); 113 114 static int tcakp_read(struct tcakp_softc *, uint8_t, uint8_t *); 115 static int tcakp_write(struct tcakp_softc *, uint8_t, uint8_t); 116 117 CFATTACH_DECL_NEW(tcakp, sizeof(struct tcakp_softc), 118 tcakp_match, tcakp_attach, NULL, NULL); 119 120 static const struct device_compatible_entry compat_data[] = { 121 { .compat = "ti,tca8418" }, 122 123 { 0 } 124 }; 125 126 static u_int 127 tcakp_decode(struct tcakp_softc *sc, uint8_t code) 128 { 129 u_int row = code / TCA_MAX_COLS; 130 u_int col = code % TCA_MAX_COLS; 131 if (col == 0) { 132 row = row - 1; 133 col = TCA_MAX_COLS - 1; 134 } else { 135 col = col - 1; 136 } 137 138 return (row << sc->sc_row_shift) + col; 139 } 140 141 static int 142 tcakp_intr(void *priv) 143 { 144 struct tcakp_softc * const sc = priv; 145 146 /* 147 * Schedule our soft interrupt handler. We can't access the i2c 148 * from hard interrupt context, so just go ahead and claim the 149 * interrupt. 150 * 151 * XXX If we ever end up with an instance that uses 152 * level-sensitive interrupts, we will need to mask 153 * the interrupt source. 154 */ 155 softint_schedule(sc->sc_sih); 156 return 1; 157 } 158 159 static void 160 tcakp_softintr(void *priv) 161 { 162 struct tcakp_softc * const sc = priv; 163 uint8_t stat, ev; 164 165 if (tcakp_i2c_lock(sc) != 0) 166 return; 167 168 tcakp_read(sc, TCA_INT_STAT, &stat); 169 if (stat & INT_STAT_K_INT) { 170 tcakp_read(sc, TCA_EVENT('A'), &ev); 171 while (ev != 0) { 172 const bool pressed = __SHIFTOUT(ev, TCA_EVENT_STATE); 173 const uint8_t code = __SHIFTOUT(ev, TCA_EVENT_CODE); 174 175 tcakp_i2c_unlock(sc); 176 177 /* Translate raw code to keymap index */ 178 const u_int index = tcakp_decode(sc, code); 179 180 u_int type = pressed ? WSCONS_EVENT_KEY_DOWN : 181 WSCONS_EVENT_KEY_UP; 182 int key = linux_key_to_usb(sc->sc_keymap[index]); 183 184 if (sc->sc_wskbddev) 185 wskbd_input(sc->sc_wskbddev, type, key); 186 187 if (tcakp_i2c_lock(sc) != 0) 188 return; 189 tcakp_read(sc, TCA_EVENT('A'), &ev); 190 } 191 } 192 tcakp_write(sc, TCA_INT_STAT, stat); 193 tcakp_i2c_unlock(sc); 194 } 195 196 static int 197 tcakp_init(struct tcakp_softc *sc) 198 { 199 uint32_t mask; 200 uint8_t val; 201 int error; 202 203 if (sc->sc_rows == 0 || sc->sc_cols == 0) { 204 aprint_error_dev(sc->sc_dev, "not configured\n"); 205 return ENXIO; 206 } 207 208 mask = __BITS(sc->sc_rows - 1, 0); 209 mask += __BITS(sc->sc_cols - 1, 0) << 8; 210 211 error = tcakp_i2c_lock(sc); 212 if (error) 213 return error; 214 215 /* Lock the keyboard */ 216 tcakp_write(sc, TCA_KEY_LCK_EC, KEY_LCK_EC_K_LCK_EN); 217 /* Select keyboard mode */ 218 tcakp_write(sc, TCA_KP_GPIO1, (mask >> 0) & 0xff); 219 tcakp_write(sc, TCA_KP_GPIO2, (mask >> 8) & 0xff); 220 tcakp_write(sc, TCA_KP_GPIO3, (mask >> 16) & 0xff); 221 /* Disable debounce */ 222 tcakp_write(sc, TCA_DEBOUNCE_DIS1, (mask >> 0) & 0xff); 223 tcakp_write(sc, TCA_DEBOUNCE_DIS2, (mask >> 8) & 0xff); 224 tcakp_write(sc, TCA_DEBOUNCE_DIS3, (mask >> 16) & 0xff); 225 /* Enable key event interrupts */ 226 tcakp_write(sc, TCA_CFG, CFG_INT_CFG | CFG_KE_IEN); 227 /* Clear interrupts */ 228 tcakp_read(sc, TCA_INT_STAT, &val); 229 tcakp_write(sc, TCA_INT_STAT, val); 230 231 tcakp_i2c_unlock(sc); 232 233 return 0; 234 } 235 236 static void 237 tcakp_configure_fdt(struct tcakp_softc *sc) 238 { 239 const uint32_t *keymap; 240 int len; 241 242 of_getprop_uint32(sc->sc_phandle, "keypad,num-rows", &sc->sc_rows); 243 of_getprop_uint32(sc->sc_phandle, "keypad,num-columns", &sc->sc_cols); 244 sc->sc_autorepeat = of_getprop_bool(sc->sc_phandle, "keypad,autorepeat"); 245 246 keymap = fdtbus_get_prop(sc->sc_phandle, "linux,keymap", &len); 247 if (keymap == NULL || len <= 0) 248 return; 249 250 sc->sc_row_shift = fls32(sc->sc_cols) - 1; 251 if (sc->sc_row_shift & (sc->sc_cols - 1)) 252 sc->sc_row_shift++; 253 254 while (len >= 4) { 255 const uint32_t e = be32toh(*keymap); 256 const u_int row = (e >> 24) & 0xff; 257 const u_int col = (e >> 16) & 0xff; 258 const u_int index = (row << sc->sc_row_shift) + col; 259 260 sc->sc_keymap[index] = e & 0xffff; 261 262 len -= 4; 263 keymap++; 264 } 265 } 266 267 static int 268 tcakp_enable(void *v, int on) 269 { 270 struct tcakp_softc * const sc = v; 271 int error; 272 273 error = tcakp_i2c_lock(sc); 274 if (error) 275 return error; 276 277 if (on) { 278 /* Disable key lock */ 279 tcakp_write(sc, TCA_KEY_LCK_EC, 0); 280 } else { 281 /* Enable key lock */ 282 tcakp_write(sc, TCA_KEY_LCK_EC, KEY_LCK_EC_K_LCK_EN); 283 } 284 285 tcakp_i2c_unlock(sc); 286 return 0; 287 } 288 289 static void 290 tcakp_set_leds(void *v, int leds) 291 { 292 } 293 294 static int 295 tcakp_ioctl(void *v, u_long cmd, void *data, int flag, lwp_t *l) 296 { 297 switch (cmd) { 298 case WSKBDIO_GTYPE: 299 *(int *)data = WSKBD_TYPE_USB; 300 return 0; 301 } 302 303 return EPASSTHROUGH; 304 } 305 306 static const struct wskbd_accessops tcakp_accessops = { 307 tcakp_enable, 308 tcakp_set_leds, 309 tcakp_ioctl, 310 }; 311 312 #if notyet 313 static void 314 tcakp_cngetc(void *v, u_int *type, int *data) 315 { 316 struct tcakp_softc * const sc = v; 317 uint8_t ev = 0; 318 319 /* XXX i2c bus acquire */ 320 321 do { 322 tcakp_read(sc, TCA_EVENT('A'), &ev); 323 } while (ev == 0); 324 325 const bool pressed = __SHIFTOUT(ev, TCA_EVENT_STATE); 326 const uint8_t code = __SHIFTOUT(ev, TCA_EVENT_CODE); 327 const u_int index = tcakp_decode(sc, code); 328 329 *type = pressed ? WSCONS_EVENT_KEY_DOWN : 330 WSCONS_EVENT_KEY_UP; 331 *data = sc->sc_keymap[index]; 332 333 /* XXX i2c bus release */ 334 } 335 336 static void 337 tcakp_cnpollc(void *v, int on) 338 { 339 } 340 341 static void 342 tcakp_cnbell(void *v, u_int pitch, u_int period, u_int volume) 343 { 344 } 345 346 static const struct wskbd_consops tcakp_consops = { 347 tcakp_cngetc, 348 tcakp_cnpollc, 349 tcakp_cnbell, 350 }; 351 #endif 352 353 extern const struct wscons_keydesc hidkbd_keydesctab[]; 354 static const struct wskbd_mapdata tcakp_keymapdata = { 355 hidkbd_keydesctab, 356 KB_US, 357 }; 358 359 static int 360 tcakp_match(device_t parent, cfdata_t match, void *aux) 361 { 362 struct i2c_attach_args *ia = aux; 363 int match_result; 364 365 if (iic_use_direct_match(ia, match, compat_data, &match_result)) 366 return match_result; 367 368 if (ia->ia_addr == 0x34) 369 return I2C_MATCH_ADDRESS_ONLY; 370 371 return 0; 372 } 373 374 static void 375 tcakp_attach(device_t parent, device_t self, void *aux) 376 { 377 struct tcakp_softc * const sc = device_private(self); 378 struct i2c_attach_args *ia = aux; 379 struct wskbddev_attach_args a; 380 381 sc->sc_dev = self; 382 sc->sc_i2c = ia->ia_tag; 383 sc->sc_addr = ia->ia_addr; 384 sc->sc_phandle = ia->ia_cookie; 385 386 aprint_naive("\n"); 387 aprint_normal(": TCA8418\n"); 388 389 #ifdef FDT 390 sc->sc_ih = fdtbus_intr_establish(sc->sc_phandle, 0, IPL_VM, 0, 391 tcakp_intr, sc); 392 /* 393 * XXX This is an edge-sensitive interrupt, but we'd like to 394 * be able to check at run-time just to be sure. 395 */ 396 if (sc->sc_ih == NULL) { 397 aprint_error_dev(sc->sc_dev, "unable to establish interrupt\n"); 398 return; 399 } 400 401 sc->sc_sih = softint_establish(SOFTINT_SERIAL, tcakp_softintr, sc); 402 if (sc->sc_sih == NULL) { 403 aprint_error_dev(sc->sc_dev, 404 "unable to establish soft interrupt\n"); 405 return; 406 } 407 408 tcakp_configure_fdt(sc); 409 #endif 410 411 if (tcakp_init(sc) != 0) 412 return; 413 414 memset(&a, 0, sizeof(a)); 415 a.console = false; /* XXX */ 416 a.keymap = &tcakp_keymapdata; 417 a.accessops = &tcakp_accessops; 418 a.accesscookie = sc; 419 420 sc->sc_wskbddev = config_found_ia(self, "wskbddev", &a, wskbddevprint); 421 } 422 423 static int 424 tcakp_i2c_lock(struct tcakp_softc *sc) 425 { 426 int error; 427 428 error = iic_acquire_bus(sc->sc_i2c, 0); 429 if (error) { 430 aprint_error_dev(sc->sc_dev, 431 "unable to acquire bus lock (%d)\n", error); 432 } 433 return error; 434 } 435 436 static void 437 tcakp_i2c_unlock(struct tcakp_softc *sc) 438 { 439 iic_release_bus(sc->sc_i2c, 0); 440 } 441 442 static int 443 tcakp_read(struct tcakp_softc *sc, uint8_t reg, uint8_t *val) 444 { 445 return iic_exec(sc->sc_i2c, I2C_OP_READ_WITH_STOP, sc->sc_addr, 446 ®, 1, val, 1, 0); 447 } 448 449 static int 450 tcakp_write(struct tcakp_softc *sc, uint8_t reg, uint8_t val) 451 { 452 uint8_t buf[2] = { reg, val }; 453 454 return iic_exec(sc->sc_i2c, I2C_OP_WRITE_WITH_STOP, 455 sc->sc_addr, NULL, 0, buf, 2, 0); 456 } 457
Indexes created Tue Sep 23 07:09:52 GMT 2025