src/modules/module-mmkbd-evdev.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2005-2006 Lennart Poettering
   5
   6   PulseAudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU Lesser General Public License as published
   8   by the Free Software Foundation; either version 2.1 of the License,
   9   or (at your option) any later version.
  10
  11   PulseAudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #ifdef HAVE_CONFIG_H
  21 #include <config.h>
  22 #endif
  23
  24 #include <stdio.h>
  25 #include <unistd.h>
  26 #include <string.h>
  27 #include <stdlib.h>
  28 #include <errno.h>
  29 #include <fcntl.h>
  30
  31 #include <linux/input.h>
  32
  33 #include <pulse/xmalloc.h>
  34
  35 #include <pulsecore/core-error.h>
  36 #include <pulsecore/module.h>
  37 #include <pulsecore/log.h>
  38 #include <pulsecore/namereg.h>
  39 #include <pulsecore/sink.h>
  40 #include <pulsecore/modargs.h>
  41 #include <pulsecore/core-util.h>
  42
  43 PA_MODULE_AUTHOR("Lennart Poettering");
  44 PA_MODULE_DESCRIPTION("Multimedia keyboard support via Linux evdev");
  45 PA_MODULE_VERSION(PACKAGE_VERSION);
  46 PA_MODULE_LOAD_ONCE(false);
  47 PA_MODULE_USAGE("device=<evdev device> sink=<sink name> volume_limit=<volume limit> volume_step=<volume change step>");
  48
  49 #define DEFAULT_DEVICE "/dev/input/event0"
  50
  51 static const char* const valid_modargs[] = {
  52     "device",
  53     "sink",
  54     "volume_limit",
  55     "volume_step",
  56     NULL,
  57 };
  58
  59 struct userdata {
  60     int fd, fd_type;
  61     pa_io_event *io;
  62     char *sink_name;
  63     pa_module *module;
  64     pa_volume_t volume_limit;
  65     pa_volume_t volume_step;
  66 };
  67
  68 static void io_callback(pa_mainloop_api *io, pa_io_event *e, int fd, pa_io_event_flags_t events, void*userdata) {
  69     struct userdata *u = userdata;
  70
  71     pa_assert(io);
  72     pa_assert(u);
  73
  74     if (events & (PA_IO_EVENT_HANGUP|PA_IO_EVENT_ERROR)) {
  75         pa_log("Lost connection to evdev device.");
  76         goto fail;
  77     }
  78
  79     if (events & PA_IO_EVENT_INPUT) {
  80         struct input_event ev;
  81
  82         if (pa_loop_read(u->fd, &ev, sizeof(ev), &u->fd_type) <= 0) {
  83             pa_log("Failed to read from event device: %s", pa_cstrerror(errno));
  84             goto fail;
  85         }
  86
  87         if (ev.type == EV_KEY && (ev.value == 1 || ev.value == 2)) {
  88             enum {
  89                 INVALID,
  90                 UP,
  91                 DOWN,
  92                 MUTE_TOGGLE
  93             } volchange = INVALID;
  94
  95             pa_log_debug("Key code=%u, value=%u", ev.code, ev.value);
  96
  97             switch (ev.code) {
  98                 case KEY_VOLUMEDOWN:
  99                     volchange = DOWN;
 100                     break;
 101
 102                 case KEY_VOLUMEUP:
 103                     volchange = UP;
 104                     break;
 105
 106                 case KEY_MUTE:
 107                     volchange = MUTE_TOGGLE;
 108                     break;
 109             }
 110
 111             if (volchange != INVALID) {
 112                 pa_sink *s;
 113
 114                 if (!(s = pa_namereg_get(u->module->core, u->sink_name, PA_NAMEREG_SINK)))
 115                     pa_log("Failed to get sink '%s'", u->sink_name);
 116                 else {
 117                     pa_cvolume cv = *pa_sink_get_volume(s, false);
 118
 119                     switch (volchange) {
 120                         case UP:
 121                             pa_cvolume_inc_clamp(&cv, u->volume_step, u->volume_limit);
 122                             pa_sink_set_volume(s, &cv, true, true);
 123                             break;
 124
 125                         case DOWN:
 126                             pa_cvolume_dec(&cv, u->volume_step);
 127                             pa_sink_set_volume(s, &cv, true, true);
 128                             break;
 129
 130                         case MUTE_TOGGLE:
 131                             pa_sink_set_mute(s, !pa_sink_get_mute(s, false), true);
 132                             break;
 133
 134                         case INVALID:
 135                             pa_assert_not_reached();
 136                     }
 137                 }
 138             }
 139         }
 140     }
 141
 142     return;
 143
 144 fail:
 145     u->module->core->mainloop->io_free(u->io);
 146     u->io = NULL;
 147
 148     pa_module_unload_request(u->module, true);
 149 }
 150
 151 #define test_bit(bit, array) (array[bit/8] & (1<<(bit%8)))
 152
 153 int pa__init(pa_module*m) {
 154
 155     pa_modargs *ma = NULL;
 156     struct userdata *u;
 157     int version;
 158     struct input_id input_id;
 159     char name[256];
 160     uint8_t evtype_bitmask[EV_MAX/8 + 1];
 161     pa_volume_t volume_limit = PA_VOLUME_NORM*3/2;
 162     pa_volume_t volume_step = PA_VOLUME_NORM/20;
 163
 164     pa_assert(m);
 165
 166     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 167         pa_log("Failed to parse module arguments");
 168         goto fail;
 169     }
 170
 171     if (pa_modargs_get_value_u32(ma, "volume_limit", &volume_limit) < 0) {
 172         pa_log("Failed to parse volume limit");
 173         goto fail;
 174     }
 175
 176     if (pa_modargs_get_value_u32(ma, "volume_step", &volume_step) < 0) {
 177         pa_log("Failed to parse volume step");
 178         goto fail;
 179     }
 180
 181     m->userdata = u = pa_xnew(struct userdata, 1);
 182     u->module = m;
 183     u->io = NULL;
 184     u->sink_name = pa_xstrdup(pa_modargs_get_value(ma, "sink", NULL));
 185     u->fd = -1;
 186     u->fd_type = 0;
 187     u->volume_limit = PA_CLAMP_VOLUME(volume_limit);
 188     u->volume_step = PA_CLAMP_VOLUME(volume_step);
 189
 190     if ((u->fd = pa_open_cloexec(pa_modargs_get_value(ma, "device", DEFAULT_DEVICE), O_RDONLY, 0)) < 0) {
 191         pa_log("Failed to open evdev device: %s", pa_cstrerror(errno));
 192         goto fail;
 193     }
 194
 195     if (ioctl(u->fd, EVIOCGVERSION, &version) < 0) {
 196         pa_log("EVIOCGVERSION failed: %s", pa_cstrerror(errno));
 197         goto fail;
 198     }
 199
 200     pa_log_info("evdev driver version %i.%i.%i", version >> 16, (version >> 8) & 0xff, version & 0xff);
 201
 202     if (ioctl(u->fd, EVIOCGID, &input_id)) {
 203         pa_log("EVIOCGID failed: %s", pa_cstrerror(errno));
 204         goto fail;
 205     }
 206
 207     pa_log_info("evdev vendor 0x%04hx product 0x%04hx version 0x%04hx bustype %u",
 208                 input_id.vendor, input_id.product, input_id.version, input_id.bustype);
 209
 210     memset(name, 0, sizeof(name));
 211     if (ioctl(u->fd, EVIOCGNAME(sizeof(name)), name) < 0) {
 212         pa_log("EVIOCGNAME failed: %s", pa_cstrerror(errno));
 213         goto fail;
 214     }
 215
 216     pa_log_info("evdev device name: %s", name);
 217
 218     memset(evtype_bitmask, 0, sizeof(evtype_bitmask));
 219     if (ioctl(u->fd, EVIOCGBIT(0, EV_MAX), evtype_bitmask) < 0) {
 220         pa_log("EVIOCGBIT failed: %s", pa_cstrerror(errno));
 221         goto fail;
 222     }
 223
 224     if (!test_bit(EV_KEY, evtype_bitmask)) {
 225         pa_log("Device has no keys.");
 226         goto fail;
 227     }
 228
 229     u->io = m->core->mainloop->io_new(m->core->mainloop, u->fd, PA_IO_EVENT_INPUT|PA_IO_EVENT_HANGUP, io_callback, u);
 230
 231     pa_modargs_free(ma);
 232
 233     return 0;
 234
 235 fail:
 236
 237     if (ma)
 238         pa_modargs_free(ma);
 239
 240     pa__done(m);
 241     return -1;
 242 }
 243
 244 void pa__done(pa_module*m) {
 245     struct userdata *u;
 246
 247     pa_assert(m);
 248
 249     if (!(u = m->userdata))
 250         return;
 251
 252     if (u->io)
 253         m->core->mainloop->io_free(u->io);
 254
 255     if (u->fd >= 0) {
 256         int r = pa_close(u->fd);
 257         if (r < 0) /* https://bugs.freedesktop.org/show_bug.cgi?id=80867 */
 258             pa_log("Closing fd failed: %s", pa_cstrerror(errno));
 259     }
 260
 261     pa_xfree(u->sink_name);
 262     pa_xfree(u);
 263 }