src/udev/udev-builtin-input_id.c

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