1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * ebcdic keycode functions for s390 console drivers 4 * 5 * S390 version 6 * Copyright IBM Corp. 2003 7 * Author(s): Martin Schwidefsky (schwidefsky@de.ibm.com), 8 */ 9 10 #include <linux/export.h> 11 #include <linux/module.h> 12 #include <linux/sched/signal.h> 13 #include <linux/slab.h> 14 #include <linux/sysrq.h> 15 16 #include <linux/consolemap.h> 17 #include <linux/kbd_kern.h> 18 #include <linux/kbd_diacr.h> 19 #include <linux/uaccess.h> 20 21 #include "keyboard.h" 22 23 /* 24 * Handler Tables. 25 */ 26 #define K_HANDLERS\ 27 k_self, k_fn, k_spec, k_ignore,\ 28 k_dead, k_ignore, k_ignore, k_ignore,\ 29 k_ignore, k_ignore, k_ignore, k_ignore,\ 30 k_ignore, k_ignore, k_ignore, k_ignore 31 32 typedef void (k_handler_fn)(struct kbd_data *, unsigned char); 33 static k_handler_fn K_HANDLERS; 34 static k_handler_fn *k_handler[16] = { K_HANDLERS }; 35 36 /* maximum values each key_handler can handle */ 37 static const int kbd_max_vals[] = { 38 255, ARRAY_SIZE(func_table) - 1, NR_FN_HANDLER - 1, 0, 39 NR_DEAD - 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 40 }; 41 static const int KBD_NR_TYPES = ARRAY_SIZE(kbd_max_vals); 42 43 static const unsigned char ret_diacr[NR_DEAD] = { 44 '`', /* dead_grave */ 45 '\'', /* dead_acute */ 46 '^', /* dead_circumflex */ 47 '~', /* dead_tilda */ 48 '"', /* dead_diaeresis */ 49 ',', /* dead_cedilla */ 50 '_', /* dead_macron */ 51 'U', /* dead_breve */ 52 '.', /* dead_abovedot */ 53 '*', /* dead_abovering */ 54 '=', /* dead_doubleacute */ 55 'c', /* dead_caron */ 56 'k', /* dead_ogonek */ 57 'i', /* dead_iota */ 58 '#', /* dead_voiced_sound */ 59 'o', /* dead_semivoiced_sound */ 60 '!', /* dead_belowdot */ 61 '?', /* dead_hook */ 62 '+', /* dead_horn */ 63 '-', /* dead_stroke */ 64 ')', /* dead_abovecomma */ 65 '(', /* dead_abovereversedcomma */ 66 ':', /* dead_doublegrave */ 67 'n', /* dead_invertedbreve */ 68 ';', /* dead_belowcomma */ 69 '$', /* dead_currency */ 70 '@', /* dead_greek */ 71 }; 72 73 /* 74 * Alloc/free of kbd_data structures. 75 */ 76 struct kbd_data * 77 kbd_alloc(void) { 78 struct kbd_data *kbd; 79 int i; 80 81 kbd = kzalloc_obj(struct kbd_data); 82 if (!kbd) 83 goto out; 84 kbd->key_maps = kcalloc(ARRAY_SIZE(ebc_key_maps), 85 sizeof(*kbd->key_maps), GFP_KERNEL); 86 if (!kbd->key_maps) 87 goto out_kbd; 88 for (i = 0; i < ARRAY_SIZE(ebc_key_maps); i++) { 89 if (ebc_key_maps[i]) { 90 kbd->key_maps[i] = kmemdup(ebc_key_maps[i], 91 sizeof(u_short) * NR_KEYS, 92 GFP_KERNEL); 93 if (!kbd->key_maps[i]) 94 goto out_maps; 95 } 96 } 97 kbd->func_table = kcalloc(ARRAY_SIZE(ebc_func_table), 98 sizeof(*kbd->func_table), GFP_KERNEL); 99 if (!kbd->func_table) 100 goto out_maps; 101 for (i = 0; i < ARRAY_SIZE(ebc_func_table); i++) { 102 if (ebc_func_table[i]) { 103 kbd->func_table[i] = kstrdup(ebc_func_table[i], 104 GFP_KERNEL); 105 if (!kbd->func_table[i]) 106 goto out_func; 107 } 108 } 109 kbd->fn_handler = 110 kzalloc_objs(fn_handler_fn *, NR_FN_HANDLER); 111 if (!kbd->fn_handler) 112 goto out_func; 113 kbd->accent_table = kmemdup(ebc_accent_table, 114 sizeof(struct kbdiacruc) * MAX_DIACR, 115 GFP_KERNEL); 116 if (!kbd->accent_table) 117 goto out_fn_handler; 118 kbd->accent_table_size = ebc_accent_table_size; 119 return kbd; 120 121 out_fn_handler: 122 kfree(kbd->fn_handler); 123 out_func: 124 for (i = 0; i < ARRAY_SIZE(ebc_func_table); i++) 125 kfree(kbd->func_table[i]); 126 kfree(kbd->func_table); 127 out_maps: 128 for (i = 0; i < ARRAY_SIZE(ebc_key_maps); i++) 129 kfree(kbd->key_maps[i]); 130 kfree(kbd->key_maps); 131 out_kbd: 132 kfree(kbd); 133 out: 134 return NULL; 135 } 136 137 void 138 kbd_free(struct kbd_data *kbd) 139 { 140 int i; 141 142 kfree(kbd->accent_table); 143 kfree(kbd->fn_handler); 144 for (i = 0; i < ARRAY_SIZE(ebc_func_table); i++) 145 kfree(kbd->func_table[i]); 146 kfree(kbd->func_table); 147 for (i = 0; i < ARRAY_SIZE(ebc_key_maps); i++) 148 kfree(kbd->key_maps[i]); 149 kfree(kbd->key_maps); 150 kfree(kbd); 151 } 152 153 /* 154 * Generate ascii -> ebcdic translation table from kbd_data. 155 */ 156 void 157 kbd_ascebc(struct kbd_data *kbd, unsigned char *ascebc) 158 { 159 unsigned short *keymap, keysym; 160 int i, j, k; 161 162 memset(ascebc, 0x40, 256); 163 for (i = 0; i < ARRAY_SIZE(ebc_key_maps); i++) { 164 keymap = kbd->key_maps[i]; 165 if (!keymap) 166 continue; 167 for (j = 0; j < NR_KEYS; j++) { 168 k = ((i & 1) << 7) + j; 169 keysym = keymap[j]; 170 if (KTYP(keysym) == (KT_LATIN | 0xf0) || 171 KTYP(keysym) == (KT_LETTER | 0xf0)) 172 ascebc[KVAL(keysym)] = k; 173 else if (KTYP(keysym) == (KT_DEAD | 0xf0)) 174 ascebc[ret_diacr[KVAL(keysym)]] = k; 175 } 176 } 177 } 178 179 #if 0 180 /* 181 * Generate ebcdic -> ascii translation table from kbd_data. 182 */ 183 void 184 kbd_ebcasc(struct kbd_data *kbd, unsigned char *ebcasc) 185 { 186 unsigned short *keymap, keysym; 187 int i, j, k; 188 189 memset(ebcasc, ' ', 256); 190 for (i = 0; i < ARRAY_SIZE(ebc_key_maps); i++) { 191 keymap = kbd->key_maps[i]; 192 if (!keymap) 193 continue; 194 for (j = 0; j < NR_KEYS; j++) { 195 keysym = keymap[j]; 196 k = ((i & 1) << 7) + j; 197 if (KTYP(keysym) == (KT_LATIN | 0xf0) || 198 KTYP(keysym) == (KT_LETTER | 0xf0)) 199 ebcasc[k] = KVAL(keysym); 200 else if (KTYP(keysym) == (KT_DEAD | 0xf0)) 201 ebcasc[k] = ret_diacr[KVAL(keysym)]; 202 } 203 } 204 } 205 #endif 206 207 /* 208 * We have a combining character DIACR here, followed by the character CH. 209 * If the combination occurs in the table, return the corresponding value. 210 * Otherwise, if CH is a space or equals DIACR, return DIACR. 211 * Otherwise, conclude that DIACR was not combining after all, 212 * queue it and return CH. 213 */ 214 static unsigned int 215 handle_diacr(struct kbd_data *kbd, unsigned int ch) 216 { 217 int i, d; 218 219 d = kbd->diacr; 220 kbd->diacr = 0; 221 222 for (i = 0; i < kbd->accent_table_size; i++) { 223 if (kbd->accent_table[i].diacr == d && 224 kbd->accent_table[i].base == ch) 225 return kbd->accent_table[i].result; 226 } 227 228 if (ch == ' ' || ch == d) 229 return d; 230 231 kbd_put_queue(kbd->port, d); 232 return ch; 233 } 234 235 /* 236 * Handle dead key. 237 */ 238 static void 239 k_dead(struct kbd_data *kbd, unsigned char value) 240 { 241 value = ret_diacr[value]; 242 kbd->diacr = (kbd->diacr ? handle_diacr(kbd, value) : value); 243 } 244 245 /* 246 * Normal character handler. 247 */ 248 static void 249 k_self(struct kbd_data *kbd, unsigned char value) 250 { 251 if (kbd->diacr) 252 value = handle_diacr(kbd, value); 253 kbd_put_queue(kbd->port, value); 254 } 255 256 /* 257 * Special key handlers 258 */ 259 static void 260 k_ignore(struct kbd_data *kbd, unsigned char value) 261 { 262 } 263 264 /* 265 * Function key handler. 266 */ 267 static void 268 k_fn(struct kbd_data *kbd, unsigned char value) 269 { 270 if (kbd->func_table[value]) 271 kbd_puts_queue(kbd->port, kbd->func_table[value]); 272 } 273 274 static void 275 k_spec(struct kbd_data *kbd, unsigned char value) 276 { 277 if (value >= NR_FN_HANDLER) 278 return; 279 if (kbd->fn_handler[value]) 280 kbd->fn_handler[value](kbd); 281 } 282 283 /* 284 * Put utf8 character to tty flip buffer. 285 * UTF-8 is defined for words of up to 31 bits, 286 * but we need only 16 bits here 287 */ 288 static void 289 to_utf8(struct tty_port *port, ushort c) 290 { 291 if (c < 0x80) 292 /* 0******* */ 293 kbd_put_queue(port, c); 294 else if (c < 0x800) { 295 /* 110***** 10****** */ 296 kbd_put_queue(port, 0xc0 | (c >> 6)); 297 kbd_put_queue(port, 0x80 | (c & 0x3f)); 298 } else { 299 /* 1110**** 10****** 10****** */ 300 kbd_put_queue(port, 0xe0 | (c >> 12)); 301 kbd_put_queue(port, 0x80 | ((c >> 6) & 0x3f)); 302 kbd_put_queue(port, 0x80 | (c & 0x3f)); 303 } 304 } 305 306 /* 307 * Process keycode. 308 */ 309 void 310 kbd_keycode(struct kbd_data *kbd, unsigned int keycode) 311 { 312 unsigned short keysym; 313 unsigned char type, value; 314 315 if (!kbd) 316 return; 317 318 if (keycode >= 384) 319 keysym = kbd->key_maps[5][keycode - 384]; 320 else if (keycode >= 256) 321 keysym = kbd->key_maps[4][keycode - 256]; 322 else if (keycode >= 128) 323 keysym = kbd->key_maps[1][keycode - 128]; 324 else 325 keysym = kbd->key_maps[0][keycode]; 326 327 type = KTYP(keysym); 328 if (type >= 0xf0) { 329 type -= 0xf0; 330 if (type == KT_LETTER) 331 type = KT_LATIN; 332 value = KVAL(keysym); 333 #ifdef CONFIG_MAGIC_SYSRQ /* Handle the SysRq Hack */ 334 if (kbd->sysrq) { 335 if (kbd->sysrq == K(KT_LATIN, '-')) { 336 kbd->sysrq = 0; 337 handle_sysrq(value); 338 return; 339 } 340 if (value == '-') { 341 kbd->sysrq = K(KT_LATIN, '-'); 342 return; 343 } 344 /* Incomplete sysrq sequence. */ 345 (*k_handler[KTYP(kbd->sysrq)])(kbd, KVAL(kbd->sysrq)); 346 kbd->sysrq = 0; 347 } else if ((type == KT_LATIN && value == '^') || 348 (type == KT_DEAD && ret_diacr[value] == '^')) { 349 kbd->sysrq = K(type, value); 350 return; 351 } 352 #endif 353 (*k_handler[type])(kbd, value); 354 } else 355 to_utf8(kbd->port, keysym); 356 } 357 358 /* 359 * Ioctl stuff. 360 */ 361 static int 362 do_kdsk_ioctl(struct kbd_data *kbd, struct kbentry __user *user_kbe, 363 int cmd, int perm) 364 { 365 struct kbentry tmp; 366 unsigned long kb_index, kb_table; 367 ushort *key_map, val, ov; 368 369 if (copy_from_user(&tmp, user_kbe, sizeof(struct kbentry))) 370 return -EFAULT; 371 kb_index = (unsigned long) tmp.kb_index; 372 #if NR_KEYS < 256 373 if (kb_index >= NR_KEYS) 374 return -EINVAL; 375 #endif 376 kb_table = (unsigned long) tmp.kb_table; 377 #if MAX_NR_KEYMAPS < 256 378 if (kb_table >= MAX_NR_KEYMAPS) 379 return -EINVAL; 380 kb_table = array_index_nospec(kb_table , MAX_NR_KEYMAPS); 381 #endif 382 383 switch (cmd) { 384 case KDGKBENT: 385 key_map = kbd->key_maps[kb_table]; 386 if (key_map) { 387 val = U(key_map[kb_index]); 388 if (KTYP(val) >= KBD_NR_TYPES) 389 val = K_HOLE; 390 } else 391 val = (kb_index ? K_HOLE : K_NOSUCHMAP); 392 return put_user(val, &user_kbe->kb_value); 393 case KDSKBENT: 394 if (!perm) 395 return -EPERM; 396 if (!kb_index && tmp.kb_value == K_NOSUCHMAP) { 397 /* disallocate map */ 398 key_map = kbd->key_maps[kb_table]; 399 if (key_map) { 400 kbd->key_maps[kb_table] = NULL; 401 kfree(key_map); 402 } 403 break; 404 } 405 406 if (KTYP(tmp.kb_value) >= KBD_NR_TYPES) 407 return -EINVAL; 408 if (KVAL(tmp.kb_value) > kbd_max_vals[KTYP(tmp.kb_value)]) 409 return -EINVAL; 410 411 if (!(key_map = kbd->key_maps[kb_table])) { 412 int j; 413 414 key_map = kmalloc(sizeof(plain_map), 415 GFP_KERNEL); 416 if (!key_map) 417 return -ENOMEM; 418 kbd->key_maps[kb_table] = key_map; 419 for (j = 0; j < NR_KEYS; j++) 420 key_map[j] = U(K_HOLE); 421 } 422 ov = U(key_map[kb_index]); 423 if (tmp.kb_value == ov) 424 break; /* nothing to do */ 425 /* 426 * Attention Key. 427 */ 428 if (((ov == K_SAK) || (tmp.kb_value == K_SAK)) && 429 !capable(CAP_SYS_ADMIN)) 430 return -EPERM; 431 key_map[kb_index] = U(tmp.kb_value); 432 break; 433 } 434 return 0; 435 } 436 437 static int 438 do_kdgkb_ioctl(struct kbd_data *kbd, struct kbsentry __user *u_kbs, 439 int cmd, int perm) 440 { 441 unsigned char kb_func; 442 char *p; 443 int len; 444 445 /* Get u_kbs->kb_func. */ 446 if (get_user(kb_func, &u_kbs->kb_func)) 447 return -EFAULT; 448 #if MAX_NR_FUNC < 256 449 if (kb_func >= MAX_NR_FUNC) 450 return -EINVAL; 451 #endif 452 453 switch (cmd) { 454 case KDGKBSENT: 455 p = kbd->func_table[kb_func]; 456 if (p) { 457 len = strlen(p); 458 if (len >= sizeof(u_kbs->kb_string)) 459 len = sizeof(u_kbs->kb_string) - 1; 460 if (copy_to_user(u_kbs->kb_string, p, len)) 461 return -EFAULT; 462 } else 463 len = 0; 464 if (put_user('\0', u_kbs->kb_string + len)) 465 return -EFAULT; 466 break; 467 case KDSKBSENT: 468 if (!perm) 469 return -EPERM; 470 p = strndup_user(u_kbs->kb_string, sizeof(u_kbs->kb_string)); 471 if (IS_ERR(p)) 472 return PTR_ERR(p); 473 kfree(kbd->func_table[kb_func]); 474 kbd->func_table[kb_func] = p; 475 break; 476 } 477 return 0; 478 } 479 480 int kbd_ioctl(struct kbd_data *kbd, unsigned int cmd, unsigned long arg) 481 { 482 struct tty_struct *tty; 483 void __user *argp; 484 unsigned int ct; 485 int perm; 486 487 argp = (void __user *)arg; 488 489 /* 490 * To have permissions to do most of the vt ioctls, we either have 491 * to be the owner of the tty, or have CAP_SYS_TTY_CONFIG. 492 */ 493 tty = tty_port_tty_get(kbd->port); 494 /* FIXME this test is pretty racy */ 495 perm = current->signal->tty == tty || capable(CAP_SYS_TTY_CONFIG); 496 tty_kref_put(tty); 497 switch (cmd) { 498 case KDGKBTYPE: 499 return put_user(KB_101, (char __user *)argp); 500 case KDGKBENT: 501 case KDSKBENT: 502 return do_kdsk_ioctl(kbd, argp, cmd, perm); 503 case KDGKBSENT: 504 case KDSKBSENT: 505 return do_kdgkb_ioctl(kbd, argp, cmd, perm); 506 case KDGKBDIACR: 507 { 508 struct kbdiacrs __user *a = argp; 509 struct kbdiacr diacr; 510 int i; 511 512 if (put_user(kbd->accent_table_size, &a->kb_cnt)) 513 return -EFAULT; 514 for (i = 0; i < kbd->accent_table_size; i++) { 515 diacr.diacr = kbd->accent_table[i].diacr; 516 diacr.base = kbd->accent_table[i].base; 517 diacr.result = kbd->accent_table[i].result; 518 if (copy_to_user(a->kbdiacr + i, &diacr, sizeof(struct kbdiacr))) 519 return -EFAULT; 520 } 521 return 0; 522 } 523 case KDGKBDIACRUC: 524 { 525 struct kbdiacrsuc __user *a = argp; 526 527 ct = kbd->accent_table_size; 528 if (put_user(ct, &a->kb_cnt)) 529 return -EFAULT; 530 if (copy_to_user(a->kbdiacruc, kbd->accent_table, 531 ct * sizeof(struct kbdiacruc))) 532 return -EFAULT; 533 return 0; 534 } 535 case KDSKBDIACR: 536 { 537 struct kbdiacrs __user *a = argp; 538 struct kbdiacr diacr; 539 int i; 540 541 if (!perm) 542 return -EPERM; 543 if (get_user(ct, &a->kb_cnt)) 544 return -EFAULT; 545 if (ct >= MAX_DIACR) 546 return -EINVAL; 547 kbd->accent_table_size = ct; 548 for (i = 0; i < ct; i++) { 549 if (copy_from_user(&diacr, a->kbdiacr + i, sizeof(struct kbdiacr))) 550 return -EFAULT; 551 kbd->accent_table[i].diacr = diacr.diacr; 552 kbd->accent_table[i].base = diacr.base; 553 kbd->accent_table[i].result = diacr.result; 554 } 555 return 0; 556 } 557 case KDSKBDIACRUC: 558 { 559 struct kbdiacrsuc __user *a = argp; 560 561 if (!perm) 562 return -EPERM; 563 if (get_user(ct, &a->kb_cnt)) 564 return -EFAULT; 565 if (ct >= MAX_DIACR) 566 return -EINVAL; 567 kbd->accent_table_size = ct; 568 if (copy_from_user(kbd->accent_table, a->kbdiacruc, 569 ct * sizeof(struct kbdiacruc))) 570 return -EFAULT; 571 return 0; 572 } 573 default: 574 return -ENOIOCTLCMD; 575 } 576 } 577 578 EXPORT_SYMBOL(kbd_ioctl); 579 EXPORT_SYMBOL(kbd_ascebc); 580 EXPORT_SYMBOL(kbd_free); 581 EXPORT_SYMBOL(kbd_alloc); 582 EXPORT_SYMBOL(kbd_keycode); 583