path: root/nixos/modules/services/hardware/thinkfan.nix

{
  config,
  lib,
  pkgs,
  ...
}:
let

  cfg = config.services.thinkfan;
  settingsFormat = pkgs.formats.yaml { };
  configFile = settingsFormat.generate "thinkfan.yaml" cfg.settings;
  thinkfan = pkgs.thinkfan.override { inherit (cfg) smartSupport; };

  # fan-speed and temperature levels
  levelType =
    with lib.types;
    let
      tuple =
        ts:
        lib.mkOptionType {
          name = "tuple";
          merge = lib.mergeOneOption;
          check = xs: lib.all lib.id (lib.zipListsWith (t: x: t.check x) ts xs);
          description = "tuple of" + lib.concatMapStrings (t: " (${t.description})") ts;
        };
      level = ints.unsigned;
      special = enum [
        "level auto"
        "level full-speed"
        "level disengaged"
      ];
    in
    tuple [
      (either level special)
      level
      level
    ];

  # sensor or fan config
  sensorType =
    name:
    lib.types.submodule {
      freeformType = lib.types.attrsOf settingsFormat.type;
      options = {
        type = lib.mkOption {
          type = lib.types.enum [
            "hwmon"
            "atasmart"
            "tpacpi"
            "nvml"
          ];
          description = ''
            The ${name} type, can be
            `hwmon` for standard ${name}s,

            `atasmart` to read the temperature via
            S.M.A.R.T (requires smartSupport to be enabled),

            `tpacpi` for the legacy thinkpac_acpi driver, or

            `nvml` for the (proprietary) nVidia driver.
          '';
        };
        query = lib.mkOption {
          type = lib.types.str;
          description = ''
            The query string used to match one or more ${name}s: can be
            a fullpath to the temperature file (single ${name}) or a fullpath
            to a driver directory (multiple ${name}s).

            ::: {.note}
            When multiple ${name}s match, the query can be restricted using the
            {option}`name` or {option}`indices` options.
            :::
          '';
        };
        indices = lib.mkOption {
          type = with lib.types; nullOr (listOf ints.unsigned);
          default = null;
          description = ''
            A list of ${name}s to pick in case multiple ${name}s match the query.

            ::: {.note}
            Indices start from 0.
            :::
          '';
        };
      }
      // lib.optionalAttrs (name == "sensor") {
        correction = lib.mkOption {
          type = with lib.types; nullOr (listOf int);
          default = null;
          description = ''
            A list of values to be added to the temperature of each sensor,
            can be used to equalize small discrepancies in temperature ratings.
          '';
        };
      };
    };

  # removes NixOS special and unused attributes
  sensorToConf =
    { type, query, ... }@args:
    (lib.filterAttrs (k: v: v != null) (
      lib.removeAttrs args [
        "type"
        "query"
      ]
    ))
    // {
      "${type}" = query;
    };

  syntaxNote = name: ''
    ::: {.note}
    This section slightly departs from the thinkfan.conf syntax.
    The type and path must be specified like this:
    ```
      type = "tpacpi";
      query = "/proc/acpi/ibm/${name}";
    ```
    instead of a single declaration like:
    ```
      - tpacpi: /proc/acpi/ibm/${name}
    ```
    :::
  '';

in
{

  options = {

    services.thinkfan = {

      enable = lib.mkOption {
        type = lib.types.bool;
        default = false;
        description = ''
          Whether to enable thinkfan, a fan control program.

          ::: {.note}
          This module targets IBM/Lenovo thinkpads by default, for
          other hardware you will have configure it more carefully.
          :::
        '';
        relatedPackages = [ "thinkfan" ];
      };

      smartSupport = lib.mkOption {
        type = lib.types.bool;
        default = false;
        description = ''
          Whether to build thinkfan with S.M.A.R.T. support to read temperatures
          directly from hard disks.
        '';
      };

      sensors = lib.mkOption {
        type = lib.types.listOf (sensorType "sensor");
        default = [
          {
            type = "tpacpi";
            query = "/proc/acpi/ibm/thermal";
          }
        ];
        description = ''
          List of temperature sensors thinkfan will monitor.

          ${syntaxNote "thermal"}
        '';
      };

      fans = lib.mkOption {
        type = lib.types.listOf (sensorType "fan");
        default = [
          {
            type = "tpacpi";
            query = "/proc/acpi/ibm/fan";
          }
        ];
        description = ''
          List of fans thinkfan will control.

          ${syntaxNote "fan"}
        '';
      };

      levels = lib.mkOption {
        type = lib.types.listOf levelType;
        default = [
          [
            0
            0
            55
          ]
          [
            1
            48
            60
          ]
          [
            2
            50
            61
          ]
          [
            3
            52
            63
          ]
          [
            6
            56
            65
          ]
          [
            7
            60
            85
          ]
          [
            "level auto"
            80
            32767
          ]
        ];
        description = ''
          [LEVEL LOW HIGH]

          LEVEL is the fan level to use: it can be an integer (0-7 with thinkpad_acpi),
          "level auto" (to keep the default firmware behavior), "level full-speed" or
          "level disengaged" (to run the fan as fast as possible).
          LOW is the temperature at which to step down to the previous level.
          HIGH is the temperature at which to step up to the next level.
          All numbers are integers.
        '';
      };

      extraArgs = lib.mkOption {
        type = lib.types.listOf lib.types.str;
        default = [ ];
        example = [
          "-b"
          "0"
        ];
        description = ''
          A list of extra command line arguments to pass to thinkfan.
          Check the {manpage}`thinkfan(1)` manpage for available arguments.
        '';
      };

      settings = lib.mkOption {
        type = lib.types.attrsOf settingsFormat.type;
        default = { };
        description = ''
          Thinkfan settings. Use this option to configure thinkfan
          settings not exposed in a NixOS option or to bypass one.
          Before changing this, read the {manpage}`thinkfan.conf(5)`
          manpage and take a look at the example config file at
          <https://github.com/vmatare/thinkfan/blob/master/examples/thinkfan.yaml>
        '';
      };

    };

  };

  config = lib.mkIf cfg.enable {

    environment.systemPackages = [ thinkfan ];

    services.thinkfan.settings = lib.mapAttrs (k: v: lib.mkDefault v) {
      sensors = map sensorToConf cfg.sensors;
      fans = map sensorToConf cfg.fans;
      levels = cfg.levels;
    };

    systemd.packages = [ thinkfan ];

    systemd.services = {
      thinkfan.environment.THINKFAN_ARGS = lib.escapeShellArgs (
        [
          "-c"
          configFile
        ]
        ++ cfg.extraArgs
      );
      thinkfan.serviceConfig = {
        Restart = "on-failure";
        RestartSec = "30s";

        # Hardening
        PrivateNetwork = true;
      };

      # must be added manually, see issue #81138
      thinkfan.wantedBy = [ "multi-user.target" ];
      thinkfan-wakeup.wantedBy = [ "sleep.target" ];
      thinkfan-sleep.wantedBy = [ "sleep.target" ];
    };

    boot.extraModprobeConfig = "options thinkpad_acpi experimental=1 fan_control=1";

  };
}