extras/input_id/input_id.c

   1 /*
   2  * input_id - input device classification
   3  *
   4  * Copyright (C) 2009 Martin Pitt <martin.pitt@ubuntu.com>
   5  * Portions Copyright (C) 2004 David Zeuthen, <david@fubar.dk>
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with keymap; if not, write to the Free Software Foundation,
  19  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  20  */
  21
  22 #include <stdio.h>
  23 #include <string.h>
  24 #include <stdlib.h>
  25 #include <limits.h>
  26 #include <linux/limits.h>
  27 #include <linux/input.h>
  28
  29 #include "libudev.h"
  30
  31 /* we must use this kernel-compatible implementation */
  32 #define BITS_PER_LONG (sizeof(unsigned long) * 8)
  33 #define NBITS(x) ((((x)-1)/BITS_PER_LONG)+1)
  34 #define OFF(x)  ((x)%BITS_PER_LONG)
  35 #define BIT(x)  (1UL<<OFF(x))
  36 #define LONG(x) ((x)/BITS_PER_LONG)
  37 #define test_bit(bit, array)    ((array[LONG(bit)] >> OFF(bit)) & 1)
  38
  39 static int debug = 0;
  40 #define DBG(format, args...) { if (debug) fprintf(stderr, format, ##args); }
  41
  42 /*
  43  * Read a capability attribute and return bitmask.
  44  * @param dev udev_device
  45  * @param attr sysfs attribute name (e. g. "capabilities/key")
  46  * @param bitmask: Output array which has a sizeof of bitmask_size
  47  */
  48 static void get_cap_mask (struct udev_device *dev, const char* attr,
  49                           unsigned long *bitmask, size_t bitmask_size)
  50 {
  51         char text[4096];
  52         unsigned i;
  53         char* word;
  54         unsigned long val;
  55
  56         snprintf(text, sizeof(text), "%s", udev_device_get_sysattr_value(dev, attr));
  57
  58         DBG("%s raw kernel attribute: %s\n", attr, text);
  59
  60         memset (bitmask, 0, bitmask_size);
  61         i = 0;
  62         while ((word = strrchr(text, ' ')) != NULL) {
  63                 val = strtoul (word+1, NULL, 16);
  64                 bitmask[i] = val;
  65                 *word = '\0';
  66                 ++i;
  67         }
  68         val = strtoul (text, NULL, 16);
  69         bitmask[i] = val;
  70
  71         if (debug) {
  72                 /* printf pattern with the right unsigned long number of hex chars */
  73                 snprintf(text, sizeof(text), "  bit %%4u: %%0%zilX\n", 2*sizeof(unsigned long));
  74                 DBG("%s decoded bit map:\n", attr);
  75                 val = bitmask_size/sizeof (unsigned long);
  76                 /* skip over leading zeros */
  77                 while (bitmask[val-1] == 0 && val > 0)
  78                     --val;
  79                 for (i = 0; i < val; ++i)
  80                         DBG(text, i * BITS_PER_LONG, bitmask[i]);
  81         }
  82 }
  83
  84 /* pointer devices */
  85 static void test_pointers (const unsigned long* bitmask_ev,
  86                            const unsigned long* bitmask_abs,
  87                            const unsigned long* bitmask_key,
  88                            const unsigned long* bitmask_rel)
  89 {
  90         int is_mouse = 0;
  91         int is_touchpad = 0;
  92
  93         if (!test_bit (EV_KEY, bitmask_ev))
  94                 return;
  95
  96         if (test_bit (EV_ABS, bitmask_ev) &&
  97             test_bit (ABS_X, bitmask_abs) && test_bit (ABS_Y, bitmask_abs)) {
  98                 if (test_bit (BTN_STYLUS, bitmask_key) || test_bit (BTN_TOOL_PEN, bitmask_key))
  99                         puts("ID_INPUT_TABLET=1");
 100                 else if (test_bit (BTN_TOOL_FINGER, bitmask_key) && !test_bit (BTN_TOOL_PEN, bitmask_key))
 101                         is_touchpad = 1;
 102                 else if (test_bit (BTN_TRIGGER, bitmask_key) ||
 103                          test_bit (BTN_A, bitmask_key) ||
 104                          test_bit (BTN_1, bitmask_key))
 105                         puts("ID_INPUT_JOYSTICK=1");
 106                 else if (test_bit (BTN_MOUSE, bitmask_key))
 107                         /* This path is taken by VMware's USB mouse, which has
 108                          * absolute axes, but no touch/pressure button. */
 109                         is_mouse = 1;
 110                 else if (test_bit (BTN_TOUCH, bitmask_key))
 111                         puts("ID_INPUT_TOUCHSCREEN=1");
 112         }
 113
 114         if (test_bit (EV_REL, bitmask_ev) &&
 115             test_bit (REL_X, bitmask_rel) && test_bit (REL_Y, bitmask_rel) &&
 116             test_bit (BTN_MOUSE, bitmask_key))
 117                 is_mouse = 1;
 118
 119         if (is_mouse)
 120                 puts("ID_INPUT_MOUSE=1");
 121         if (is_touchpad)
 122                 puts("ID_INPUT_TOUCHPAD=1");
 123 }
 124
 125 /* key like devices */
 126 static void test_key (const unsigned long* bitmask_ev,
 127                       const unsigned long* bitmask_key)
 128 {
 129         unsigned i;
 130         unsigned long found;
 131         unsigned long mask;
 132
 133         /* do we have any KEY_* capability? */
 134         if (!test_bit (EV_KEY, bitmask_ev)) {
 135                 DBG("test_key: no EV_KEY capability\n");
 136                 return;
 137         }
 138
 139         /* only consider KEY_* here, not BTN_* */
 140         found = 0;
 141         for (i = 0; i < BTN_MISC/BITS_PER_LONG; ++i) {
 142                 found |= bitmask_key[i];
 143                 DBG("test_key: checking bit block %lu for any keys; found=%i\n", i*BITS_PER_LONG, found > 0);
 144         }
 145         if (found > 0)
 146                 puts("ID_INPUT_KEY=1");
 147
 148         /* the first 32 bits are ESC, numbers, and Q to D; if we have all of
 149          * those, consider it a full keyboard; do not test KEY_RESERVED, though */
 150         mask = 0xFFFFFFFE;
 151         if ((bitmask_key[0] & mask) == mask)
 152                 puts("ID_INPUT_KEYBOARD=1");
 153 }
 154
 155 int main (int argc, char** argv)
 156 {
 157         struct udev *udev;
 158         struct udev_device *dev;
 159
 160         char devpath[PATH_MAX];
 161         unsigned long bitmask_ev[NBITS(EV_MAX)];
 162         unsigned long bitmask_abs[NBITS(ABS_MAX)];
 163         unsigned long bitmask_key[NBITS(KEY_MAX)];
 164         unsigned long bitmask_rel[NBITS(REL_MAX)];
 165
 166         if (argc != 2) {
 167                 fprintf(stderr, "Usage: %s <device path (without /sys)>\n", argv[0]);
 168                 exit(1);
 169         }
 170
 171         if (getenv ("DEBUG"))
 172                 debug = 1;
 173
 174         /* get the device */
 175         udev = udev_new();
 176         if (udev == NULL)
 177                 return 1;
 178
 179         snprintf(devpath, sizeof(devpath), "%s/%s", udev_get_sys_path(udev), argv[1]);
 180         dev = udev_device_new_from_syspath(udev, devpath);
 181         if (dev == NULL) {
 182                 fprintf(stderr, "unable to access '%s'\n", devpath);
 183                 return 1;
 184         }
 185
 186         /* walk up the parental chain until we find the real input device; the
 187          * argument is very likely a subdevice of this, like eventN */
 188         while (dev != NULL && udev_device_get_sysattr_value(dev, "capabilities/ev") == NULL)
 189                 dev = udev_device_get_parent_with_subsystem_devtype(dev, "input", NULL);
 190
 191         /* not an "input" class device */
 192         if (dev == NULL)
 193                 return 0;
 194
 195         /* Use this as a flag that input devices were detected, so that this
 196          * program doesn't need to be called more than once per device */
 197         puts("ID_INPUT=1");
 198
 199         get_cap_mask (dev, "capabilities/ev", bitmask_ev, sizeof (bitmask_ev));
 200         get_cap_mask (dev, "capabilities/abs", bitmask_abs, sizeof (bitmask_abs));
 201         get_cap_mask (dev, "capabilities/rel", bitmask_rel, sizeof (bitmask_rel));
 202         get_cap_mask (dev, "capabilities/key", bitmask_key, sizeof (bitmask_key));
 203
 204         test_pointers(bitmask_ev, bitmask_abs, bitmask_key, bitmask_rel);
 205
 206         test_key(bitmask_ev, bitmask_key);
 207
 208         return 0;
 209 }