about summary refs log tree commit diff
path: root/nixpkgs/nixos/modules/services/misc/persistent-evdev.nix
blob: 650752abd215119a08b76e0154c5c0d6699843a2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
{ config, lib, pkgs, ... }:

let
  cfg = config.services.persistent-evdev;
  settingsFormat = pkgs.formats.json {};

  configFile = settingsFormat.generate "persistent-evdev-config" {
    cache = "/var/cache/persistent-evdev";
    devices = lib.mapAttrs (virt: phys: "/dev/input/by-id/${phys}") cfg.devices;
  };
in
{
  options.services.persistent-evdev = {
    enable = lib.mkEnableOption "virtual input devices that persist even if the backing device is hotplugged";

    devices = lib.mkOption {
      default = {};
      type = with lib.types; attrsOf str;
      description = ''
        A set of virtual proxy device labels with backing physical device ids.

        Physical devices should already exist in {file}`/dev/input/by-id/`.
        Proxy devices will be automatically given a `uinput-` prefix.

        See the [project page](https://github.com/aiberia/persistent-evdev#example-usage-with-libvirt)
        for example configuration of virtual devices with libvirt
        and remember to add `uinput-*` devices to the qemu
        `cgroup_device_acl` list (see [](#opt-virtualisation.libvirtd.qemu.verbatimConfig)).
      '';
      example = lib.literalExpression ''
        {
          persist-mouse0 = "usb-Logitech_G403_Prodigy_Gaming_Mouse_078738533531-event-if01";
          persist-mouse1 = "usb-Logitech_G403_Prodigy_Gaming_Mouse_078738533531-event-mouse";
          persist-mouse2 = "usb-Logitech_G403_Prodigy_Gaming_Mouse_078738533531-if01-event-kbd";
          persist-keyboard0 = "usb-Microsoft_Natural®_Ergonomic_Keyboard_4000-event-kbd";
          persist-keyboard1 = "usb-Microsoft_Natural®_Ergonomic_Keyboard_4000-if01-event-kbd";
        }
      '';
    };
  };

  config = lib.mkIf cfg.enable {

    systemd.services.persistent-evdev = {
      documentation = [ "https://github.com/aiberia/persistent-evdev/blob/master/README.md" ];
      description = "Persistent evdev proxy";
      wantedBy = [ "multi-user.target" ];

      serviceConfig = {
        Restart = "on-failure";
        ExecStart = "${pkgs.persistent-evdev}/bin/persistent-evdev.py ${configFile}";
        CacheDirectory = "persistent-evdev";
      };
    };

    services.udev.packages = [ pkgs.persistent-evdev ];
  };

  meta.maintainers = with lib.maintainers; [ lodi ];
}