1 // SPDX-License-Identifier: GPL-2.0
3 * ebcdic keycode functions for s390 console drivers
6 * Copyright IBM Corp. 2003
7 * Author(s): Martin Schwidefsky (schwidefsky@de.ibm.com),
10 #include <linux/module.h>
11 #include <linux/sched/signal.h>
12 #include <linux/slab.h>
13 #include <linux/sysrq.h>
15 #include <linux/consolemap.h>
16 #include <linux/kbd_kern.h>
17 #include <linux/kbd_diacr.h>
18 #include <linux/uaccess.h>
26 k_self, k_fn, k_spec, k_ignore,\
27 k_dead, k_ignore, k_ignore, k_ignore,\
28 k_ignore, k_ignore, k_ignore, k_ignore,\
29 k_ignore, k_ignore, k_ignore, k_ignore
31 typedef void (k_handler_fn)(struct kbd_data *, unsigned char);
32 static k_handler_fn K_HANDLERS;
33 static k_handler_fn *k_handler[16] = { K_HANDLERS };
35 /* maximum values each key_handler can handle */
36 static const int kbd_max_vals[] = {
37 255, ARRAY_SIZE(func_table) - 1, NR_FN_HANDLER - 1, 0,
38 NR_DEAD - 1, 0, 0, 0, 0, 0, 0, 0, 0, 0
40 static const int KBD_NR_TYPES = ARRAY_SIZE(kbd_max_vals);
42 static unsigned char ret_diacr[NR_DEAD] = {
43 '`', '\'', '^', '~', '"', ','
47 * Alloc/free of kbd_data structures.
54 kbd = kzalloc(sizeof(struct kbd_data), GFP_KERNEL);
57 kbd->key_maps = kzalloc(sizeof(ebc_key_maps), GFP_KERNEL);
60 for (i = 0; i < ARRAY_SIZE(ebc_key_maps); i++) {
61 if (ebc_key_maps[i]) {
62 kbd->key_maps[i] = kmemdup(ebc_key_maps[i],
63 sizeof(u_short) * NR_KEYS,
65 if (!kbd->key_maps[i])
69 kbd->func_table = kzalloc(sizeof(ebc_func_table), GFP_KERNEL);
72 for (i = 0; i < ARRAY_SIZE(ebc_func_table); i++) {
73 if (ebc_func_table[i]) {
74 kbd->func_table[i] = kstrdup(ebc_func_table[i],
76 if (!kbd->func_table[i])
81 kcalloc(NR_FN_HANDLER, sizeof(fn_handler_fn *), GFP_KERNEL);
84 kbd->accent_table = kmemdup(ebc_accent_table,
85 sizeof(struct kbdiacruc) * MAX_DIACR,
87 if (!kbd->accent_table)
89 kbd->accent_table_size = ebc_accent_table_size;
93 kfree(kbd->fn_handler);
95 for (i = 0; i < ARRAY_SIZE(ebc_func_table); i++)
96 kfree(kbd->func_table[i]);
97 kfree(kbd->func_table);
99 for (i = 0; i < ARRAY_SIZE(ebc_key_maps); i++)
100 kfree(kbd->key_maps[i]);
101 kfree(kbd->key_maps);
109 kbd_free(struct kbd_data *kbd)
113 kfree(kbd->accent_table);
114 kfree(kbd->fn_handler);
115 for (i = 0; i < ARRAY_SIZE(ebc_func_table); i++)
116 kfree(kbd->func_table[i]);
117 kfree(kbd->func_table);
118 for (i = 0; i < ARRAY_SIZE(ebc_key_maps); i++)
119 kfree(kbd->key_maps[i]);
120 kfree(kbd->key_maps);
125 * Generate ascii -> ebcdic translation table from kbd_data.
128 kbd_ascebc(struct kbd_data *kbd, unsigned char *ascebc)
130 unsigned short *keymap, keysym;
133 memset(ascebc, 0x40, 256);
134 for (i = 0; i < ARRAY_SIZE(ebc_key_maps); i++) {
135 keymap = kbd->key_maps[i];
138 for (j = 0; j < NR_KEYS; j++) {
139 k = ((i & 1) << 7) + j;
141 if (KTYP(keysym) == (KT_LATIN | 0xf0) ||
142 KTYP(keysym) == (KT_LETTER | 0xf0))
143 ascebc[KVAL(keysym)] = k;
144 else if (KTYP(keysym) == (KT_DEAD | 0xf0))
145 ascebc[ret_diacr[KVAL(keysym)]] = k;
152 * Generate ebcdic -> ascii translation table from kbd_data.
155 kbd_ebcasc(struct kbd_data *kbd, unsigned char *ebcasc)
157 unsigned short *keymap, keysym;
160 memset(ebcasc, ' ', 256);
161 for (i = 0; i < ARRAY_SIZE(ebc_key_maps); i++) {
162 keymap = kbd->key_maps[i];
165 for (j = 0; j < NR_KEYS; j++) {
167 k = ((i & 1) << 7) + j;
168 if (KTYP(keysym) == (KT_LATIN | 0xf0) ||
169 KTYP(keysym) == (KT_LETTER | 0xf0))
170 ebcasc[k] = KVAL(keysym);
171 else if (KTYP(keysym) == (KT_DEAD | 0xf0))
172 ebcasc[k] = ret_diacr[KVAL(keysym)];
179 * We have a combining character DIACR here, followed by the character CH.
180 * If the combination occurs in the table, return the corresponding value.
181 * Otherwise, if CH is a space or equals DIACR, return DIACR.
182 * Otherwise, conclude that DIACR was not combining after all,
183 * queue it and return CH.
186 handle_diacr(struct kbd_data *kbd, unsigned int ch)
193 for (i = 0; i < kbd->accent_table_size; i++) {
194 if (kbd->accent_table[i].diacr == d &&
195 kbd->accent_table[i].base == ch)
196 return kbd->accent_table[i].result;
199 if (ch == ' ' || ch == d)
202 kbd_put_queue(kbd->port, d);
210 k_dead(struct kbd_data *kbd, unsigned char value)
212 value = ret_diacr[value];
213 kbd->diacr = (kbd->diacr ? handle_diacr(kbd, value) : value);
217 * Normal character handler.
220 k_self(struct kbd_data *kbd, unsigned char value)
223 value = handle_diacr(kbd, value);
224 kbd_put_queue(kbd->port, value);
228 * Special key handlers
231 k_ignore(struct kbd_data *kbd, unsigned char value)
236 * Function key handler.
239 k_fn(struct kbd_data *kbd, unsigned char value)
241 if (kbd->func_table[value])
242 kbd_puts_queue(kbd->port, kbd->func_table[value]);
246 k_spec(struct kbd_data *kbd, unsigned char value)
248 if (value >= NR_FN_HANDLER)
250 if (kbd->fn_handler[value])
251 kbd->fn_handler[value](kbd);
255 * Put utf8 character to tty flip buffer.
256 * UTF-8 is defined for words of up to 31 bits,
257 * but we need only 16 bits here
260 to_utf8(struct tty_port *port, ushort c)
264 kbd_put_queue(port, c);
265 else if (c < 0x800) {
266 /* 110***** 10****** */
267 kbd_put_queue(port, 0xc0 | (c >> 6));
268 kbd_put_queue(port, 0x80 | (c & 0x3f));
270 /* 1110**** 10****** 10****** */
271 kbd_put_queue(port, 0xe0 | (c >> 12));
272 kbd_put_queue(port, 0x80 | ((c >> 6) & 0x3f));
273 kbd_put_queue(port, 0x80 | (c & 0x3f));
281 kbd_keycode(struct kbd_data *kbd, unsigned int keycode)
283 unsigned short keysym;
284 unsigned char type, value;
290 keysym = kbd->key_maps[5][keycode - 384];
291 else if (keycode >= 256)
292 keysym = kbd->key_maps[4][keycode - 256];
293 else if (keycode >= 128)
294 keysym = kbd->key_maps[1][keycode - 128];
296 keysym = kbd->key_maps[0][keycode];
301 if (type == KT_LETTER)
303 value = KVAL(keysym);
304 #ifdef CONFIG_MAGIC_SYSRQ /* Handle the SysRq Hack */
306 if (kbd->sysrq == K(KT_LATIN, '-')) {
312 kbd->sysrq = K(KT_LATIN, '-');
315 /* Incomplete sysrq sequence. */
316 (*k_handler[KTYP(kbd->sysrq)])(kbd, KVAL(kbd->sysrq));
318 } else if ((type == KT_LATIN && value == '^') ||
319 (type == KT_DEAD && ret_diacr[value] == '^')) {
320 kbd->sysrq = K(type, value);
324 (*k_handler[type])(kbd, value);
326 to_utf8(kbd->port, keysym);
333 do_kdsk_ioctl(struct kbd_data *kbd, struct kbentry __user *user_kbe,
337 unsigned long kb_index, kb_table;
338 ushort *key_map, val, ov;
340 if (copy_from_user(&tmp, user_kbe, sizeof(struct kbentry)))
342 kb_index = (unsigned long) tmp.kb_index;
344 if (kb_index >= NR_KEYS)
347 kb_table = (unsigned long) tmp.kb_table;
348 #if MAX_NR_KEYMAPS < 256
349 if (kb_table >= MAX_NR_KEYMAPS)
351 kb_table = array_index_nospec(kb_table , MAX_NR_KEYMAPS);
356 key_map = kbd->key_maps[kb_table];
358 val = U(key_map[kb_index]);
359 if (KTYP(val) >= KBD_NR_TYPES)
362 val = (kb_index ? K_HOLE : K_NOSUCHMAP);
363 return put_user(val, &user_kbe->kb_value);
367 if (!kb_index && tmp.kb_value == K_NOSUCHMAP) {
368 /* disallocate map */
369 key_map = kbd->key_maps[kb_table];
371 kbd->key_maps[kb_table] = NULL;
377 if (KTYP(tmp.kb_value) >= KBD_NR_TYPES)
379 if (KVAL(tmp.kb_value) > kbd_max_vals[KTYP(tmp.kb_value)])
382 if (!(key_map = kbd->key_maps[kb_table])) {
385 key_map = kmalloc(sizeof(plain_map),
389 kbd->key_maps[kb_table] = key_map;
390 for (j = 0; j < NR_KEYS; j++)
391 key_map[j] = U(K_HOLE);
393 ov = U(key_map[kb_index]);
394 if (tmp.kb_value == ov)
395 break; /* nothing to do */
399 if (((ov == K_SAK) || (tmp.kb_value == K_SAK)) &&
400 !capable(CAP_SYS_ADMIN))
402 key_map[kb_index] = U(tmp.kb_value);
409 do_kdgkb_ioctl(struct kbd_data *kbd, struct kbsentry __user *u_kbs,
412 unsigned char kb_func;
416 /* Get u_kbs->kb_func. */
417 if (get_user(kb_func, &u_kbs->kb_func))
419 #if MAX_NR_FUNC < 256
420 if (kb_func >= MAX_NR_FUNC)
426 p = kbd->func_table[kb_func];
429 if (len >= sizeof(u_kbs->kb_string))
430 len = sizeof(u_kbs->kb_string) - 1;
431 if (copy_to_user(u_kbs->kb_string, p, len))
435 if (put_user('\0', u_kbs->kb_string + len))
441 p = strndup_user(u_kbs->kb_string, sizeof(u_kbs->kb_string));
444 kfree(kbd->func_table[kb_func]);
445 kbd->func_table[kb_func] = p;
451 int kbd_ioctl(struct kbd_data *kbd, unsigned int cmd, unsigned long arg)
453 struct tty_struct *tty;
458 argp = (void __user *)arg;
461 * To have permissions to do most of the vt ioctls, we either have
462 * to be the owner of the tty, or have CAP_SYS_TTY_CONFIG.
464 tty = tty_port_tty_get(kbd->port);
465 /* FIXME this test is pretty racy */
466 perm = current->signal->tty == tty || capable(CAP_SYS_TTY_CONFIG);
470 return put_user(KB_101, (char __user *)argp);
473 return do_kdsk_ioctl(kbd, argp, cmd, perm);
476 return do_kdgkb_ioctl(kbd, argp, cmd, perm);
479 struct kbdiacrs __user *a = argp;
480 struct kbdiacr diacr;
483 if (put_user(kbd->accent_table_size, &a->kb_cnt))
485 for (i = 0; i < kbd->accent_table_size; i++) {
486 diacr.diacr = kbd->accent_table[i].diacr;
487 diacr.base = kbd->accent_table[i].base;
488 diacr.result = kbd->accent_table[i].result;
489 if (copy_to_user(a->kbdiacr + i, &diacr, sizeof(struct kbdiacr)))
496 struct kbdiacrsuc __user *a = argp;
498 ct = kbd->accent_table_size;
499 if (put_user(ct, &a->kb_cnt))
501 if (copy_to_user(a->kbdiacruc, kbd->accent_table,
502 ct * sizeof(struct kbdiacruc)))
508 struct kbdiacrs __user *a = argp;
509 struct kbdiacr diacr;
514 if (get_user(ct, &a->kb_cnt))
518 kbd->accent_table_size = ct;
519 for (i = 0; i < ct; i++) {
520 if (copy_from_user(&diacr, a->kbdiacr + i, sizeof(struct kbdiacr)))
522 kbd->accent_table[i].diacr = diacr.diacr;
523 kbd->accent_table[i].base = diacr.base;
524 kbd->accent_table[i].result = diacr.result;
530 struct kbdiacrsuc __user *a = argp;
534 if (get_user(ct, &a->kb_cnt))
538 kbd->accent_table_size = ct;
539 if (copy_from_user(kbd->accent_table, a->kbdiacruc,
540 ct * sizeof(struct kbdiacruc)))
549 EXPORT_SYMBOL(kbd_ioctl);
550 EXPORT_SYMBOL(kbd_ascebc);
551 EXPORT_SYMBOL(kbd_free);
552 EXPORT_SYMBOL(kbd_alloc);
553 EXPORT_SYMBOL(kbd_keycode);