2 * keymap - dump keymap of an evdev device or set a new keymap from a file
4 * Based on keyfuzz by Lennart Poettering <mzqrovna@0pointer.net>
5 * Adapted for udev-extras by Martin Pitt <martin.pitt@ubuntu.com>
7 * Copyright (C) 2006, Lennart Poettering
8 * Copyright (C) 2009, Canonical Ltd.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
35 #include <sys/ioctl.h>
36 #include <linux/limits.h>
37 #include <linux/input.h>
39 static const struct key* lookup_key (const char *str, unsigned int len);
41 #include "keys-from-name.h"
42 #include "keys-to-name.h"
46 #define MAX_SCANCODES 1024
48 static int evdev_open(const char *dev)
53 if (!startswith(dev, "/dev")) {
54 snprintf(fn, sizeof(fn), "/dev/%s", dev);
58 if ((fd = open(dev, O_RDWR)) < 0) {
59 fprintf(stderr, "error open('%s'): %m\n", dev);
65 static int evdev_get_keycode(int fd, unsigned scancode, int e)
70 if (ioctl(fd, EVIOCGKEYCODE, codes) < 0) {
71 if (e && errno == EINVAL) {
74 fprintf(stderr, "EVIOCGKEYCODE for scan code 0x%x: %m\n", scancode);
81 static int evdev_set_keycode(int fd, unsigned scancode, int keycode)
86 codes[1] = (unsigned) keycode;
88 if (ioctl(fd, EVIOCSKEYCODE, codes) < 0) {
89 fprintf(stderr, "EVIOCSKEYCODE: %m\n");
95 static int evdev_driver_version(int fd, char *v, size_t l)
99 if (ioctl(fd, EVIOCGVERSION, &version)) {
100 fprintf(stderr, "EVIOCGVERSION: %m\n");
104 snprintf(v, l, "%i.%i.%i.", version >> 16, (version >> 8) & 0xff, version & 0xff);
108 static int evdev_device_name(int fd, char *n, size_t l)
110 if (ioctl(fd, EVIOCGNAME(l), n) < 0) {
111 fprintf(stderr, "EVIOCGNAME: %m\n");
117 /* Return a lower-case string with KEY_ prefix removed */
118 static const char* format_keyname(const char* key) {
119 static char result[101];
123 for (s = key+4, len = 0; *s && len < 100; ++len, ++s)
124 result[len] = tolower(*s);
129 static int dump_table(int fd) {
130 char version[256], name[256];
134 if (evdev_driver_version(fd, version, sizeof(version)) < 0)
137 if (evdev_device_name(fd, name, sizeof(name)) < 0)
140 printf("### evdev %s, driver '%s'\n", version, name);
143 for (scancode = 0; scancode < MAX_SCANCODES; scancode++) {
146 if ((keycode = evdev_get_keycode(fd, scancode, 1)) < 0) {
153 if (keycode < KEY_MAX && key_names[keycode])
154 printf("0x%03x %s\n", scancode, format_keyname(key_names[keycode]));
156 printf("0x%03x 0x%03x\n", scancode, keycode);
162 static void set_key(int fd, const char* scancode_str, const char* keyname)
166 char t[105] = "KEY_UNKNOWN";
169 scancode = (unsigned) strtol(scancode_str, &endptr, 0);
170 if (*endptr != '\0') {
171 fprintf(stderr, "ERROR: Invalid scancode\n");
175 snprintf(t, sizeof(t), "KEY_%s", keyname);
177 if (!(k = lookup_key(t, strlen(t)))) {
178 fprintf(stderr, "ERROR: Unknown key name '%s'\n", keyname);
182 if (evdev_set_keycode(fd, scancode, k->id) < 0)
183 fprintf(stderr, "setting scancode 0x%2X to key code %i failed\n",
186 printf("setting scancode 0x%2X to key code %i\n",
190 static int merge_table(int fd, FILE *f) {
197 int new_keycode, old_keycode;
199 if (!fgets(s, sizeof(s), f))
203 p = s+strspn(s, "\t ");
204 if (*p == '#' || *p == '\n')
207 if (sscanf(p, "%i %i", &scancode, &new_keycode) != 2) {
208 char t[105] = "KEY_UNKNOWN";
211 if (sscanf(p, "%i %100s", &scancode, t+4) != 2) {
212 fprintf(stderr, "WARNING: Parse failure at line %i, ignoring.\n", line);
217 if (!(k = lookup_key(t, strlen(t)))) {
218 fprintf(stderr, "WARNING: Unknown key '%s' at line %i, ignoring.\n", t, line);
227 if ((old_keycode = evdev_get_keycode(fd, scancode, 0)) < 0) {
232 if (evdev_set_keycode(fd, scancode, new_keycode) < 0) {
237 if (new_keycode != old_keycode)
238 fprintf(stderr, "Remapped scancode 0x%02x to 0x%02x (prior: 0x%02x)\n",
239 scancode, new_keycode, old_keycode);
247 /* read one event; return 1 if valid */
248 static int read_event(int fd, struct input_event* ev)
251 ret = read(fd, ev, sizeof(struct input_event));
257 if (ret != sizeof(struct input_event)) {
258 fprintf(stderr, "did not get enough data for event struct, aborting\n");
265 static void print_key(unsigned scancode, uint16_t keycode, int has_scan, int has_key)
269 /* ignore key release events */
273 if (has_key == 0 && has_scan != 0) {
274 fprintf(stderr, "got scan code event 0x%02X without a key code event\n",
280 printf("scan code: 0x%02X ", scancode);
282 printf("(no scan code received) ");
284 keyname = key_names[keycode];
286 printf("key code: %s\n", format_keyname(keyname));
288 printf("key code: %03X\n", keycode);
291 static void interactive(int fd)
293 struct input_event ev;
294 unsigned last_scan = 0;
295 uint16_t last_key = 0;
296 int has_scan; /* boolean */
297 int has_key; /* 0: none, 1: release, 2: press */
299 /* grab input device */
300 ioctl(fd, EVIOCGRAB, 1);
301 puts("Press ESC to finish, or Control-C if this device is not your primary keyboard");
303 has_scan = has_key = 0;
304 while (read_event(fd, &ev)) {
305 /* Drivers usually send the scan code first, then the key code,
306 * then a SYN. Some drivers (like thinkpad_acpi) send the key
307 * code first, and some drivers might not send SYN events, so
308 * keep a robust state machine which can deal with any of those
311 if (ev.type == EV_MSC && ev.code == MSC_SCAN) {
313 fputs("driver did not send SYN event in between key events; previous event:\n",
315 print_key(last_scan, last_key, has_scan, has_key);
319 last_scan = ev.value;
321 /*printf("--- got scan %u; has scan %i key %i\n", last_scan, has_scan, has_key); */
323 else if (ev.type == EV_KEY) {
325 fputs("driver did not send SYN event in between key events; previous event:\n",
327 print_key(last_scan, last_key, has_scan, has_key);
332 has_key = 1 + ev.value;
333 /*printf("--- got key %hu; has scan %i key %i\n", last_key, has_scan, has_key);*/
336 if (ev.code == KEY_ESC && ev.value == 0)
339 else if (ev.type == EV_SYN) {
340 /*printf("--- got SYN; has scan %i key %i\n", has_scan, has_key);*/
341 print_key(last_scan, last_key, has_scan, has_key);
343 has_scan = has_key = 0;
348 /* release input device */
349 ioctl(fd, EVIOCGRAB, 0);
352 _noreturn_ static void help(int error)
354 const char* h = "Usage: keymap <event device> [<map file>]\n"
355 " keymap <event device> scancode keyname [...]\n"
356 " keymap -i <event device>\n";
366 int main(int argc, char **argv)
368 static const struct option options[] = {
369 { "help", no_argument, NULL, 'h' },
370 { "interactive", no_argument, NULL, 'i' },
374 int opt_interactive = 0;
380 option = getopt_long(argc, argv, "hi", options, NULL);
399 if ((fd = evdev_open(argv[optind])) < 0)
402 /* one argument (device): dump or interactive */
403 if (argc == optind+1) {
411 /* two arguments (device, mapfile): set map file */
412 if (argc == optind+2) {
413 const char *filearg = argv[optind+1];
414 if (strchr(filearg, '/')) {
415 /* Keymap file argument is a path */
416 FILE *f = fopen(filearg, "re");
422 /* Keymap file argument is a filename */
423 /* Open override file if present, otherwise default file */
424 char keymap_path[PATH_MAX];
427 snprintf(keymap_path, sizeof(keymap_path), "/etc/udev/keymaps/%s", filearg);
428 f = fopen(keymap_path, "re");
432 snprintf(keymap_path, sizeof(keymap_path), UDEVLIBEXECDIR "/keymaps/%s", filearg);
433 f = fopen(keymap_path, "re");
443 /* more arguments (device, scancode/keyname pairs): set keys directly */
444 if ((argc - optind - 1) % 2 == 0) {
445 for (i = optind+1; i < argc; i += 2)
446 set_key(fd, argv[i], argv[i+1]);
450 /* invalid number of arguments */
452 return 1; /* not reached */