Merge remote-tracking branch 'upstream/master' into microsoft/surface/6.1.3

microsoft/surface/common/default.nix

@@ -0,0 +1,24 @@
+{ lib, ... }:
+
+let
+  inherit (lib) mkDefault;
+
+in {
+  imports = [
+    ./kernel
+    ./ipts
+    ./surface-control
+  ];
+
+  microsoft-surface.kernelVersion = mkDefault "6.0.17";
+
+  # Seems to be required to properly enable S0ix "Modern Standby":
+  boot.kernelParams = mkDefault [ "mem_sleep_default=deep" ];
+
+  # NOTE: Check the README before enabling TLP:
+  services.tlp.enable = mkDefault false;
+
+  # i.e. needed for wifi firmware, see https://github.com/NixOS/nixos-hardware/issues/364
+  hardware.enableRedistributableFirmware = mkDefault true;
+  hardware.sensor.iio.enable = mkDefault true;
+}

microsoft/surface/common/ipts/default.nix

@@ -0,0 +1,27 @@
+{ config, lib, pkgs, ... }:
+
+let
+  inherit (lib) mkDefault mkEnableOption mkIf mkMerge;
+
+  cfg = config.microsoft-surface.ipts;
+
+in {
+  options.microsoft-surface.ipts = {
+    enable = mkEnableOption "Enable IPTSd for Microsoft Surface";
+  };
+
+  config = mkMerge [
+    {
+      microsoft-surface.ipts.enable = mkDefault false;
+    }
+
+    (mkIf cfg.enable {
+      systemd.services.iptsd = {
+        description = "IPTSD";
+        path = with pkgs; [ iptsd ];
+        script = "iptsd";
+        wantedBy = [ "multi-user.target" ];
+      };
+    })
+  ];
+}

microsoft/surface/common/kernel/default.nix

@@ -0,0 +1,17 @@
+{ lib, ... }:
+
+let
+  inherit (lib) mkOption types;
+
+in {
+  imports = [
+    ./linux-5.19.17
+    ./linux-6.0.17
+    ./linux-6.1.3
+  ];
+
+  options.microsoft-surface.kernelVersion = mkOption {
+    description = "Kernel Version to use (patched for MS Surface)";
+    type = types.enum [ ];
+  };
+}

microsoft/surface/common/kernel/linux-5.19.17/default.nix

@@ -0,0 +1,37 @@
+{ config, lib, pkgs, ... }:
+
+let
+  inherit (lib) mkIf mkOption types;
+  inherit (pkgs) fetchurl;
+
+  inherit (pkgs.callPackage ../linux-package.nix { }) linuxPackage repos;
+
+  cfg = config.microsoft-surface;
+
+  version = "5.19.17";
+  extraMeta.branch = "5.19";
+  patchDir = repos.linux-surface + "/patches/${extraMeta.branch}";
+  kernelPatches = pkgs.callPackage ./patches.nix {
+    inherit (lib) kernel;
+    inherit version patchDir;
+  };
+
+  kernelPackages = linuxPackage {
+    inherit version extraMeta kernelPatches;
+    src = fetchurl {
+      url = "mirror://kernel/linux/kernel/v5.x/linux-${version}.tar.xz";
+      sha256 = "sha256-yTuzhKl60fCk8Y5ELOApEkJyL3gCPspliyI0RUHwlIk=";
+    };
+  };
+
+in {
+  options.microsoft-surface.kernelVersion = mkOption {
+    type = types.enum [ "5.19.17" ];
+  };
+
+  config = mkIf (cfg.kernelVersion == "5.19.17") {
+    boot = {
+      inherit kernelPackages;
+    };
+  };
+}

microsoft/surface/common/kernel/linux-5.19.17/patches.nix

@@ -0,0 +1,123 @@
+{ kernel,
+  patchDir,
+  version,
+}:
+
+[
+  {
+    name = "microsoft-surface-patches-linux-${version}";
+    patch = null;
+    structuredExtraConfig = with kernel; {
+      #
+      # Surface Aggregator Module
+      #
+      SURFACE_AGGREGATOR = module;
+      SURFACE_AGGREGATOR_ERROR_INJECTION = no;
+      SURFACE_AGGREGATOR_BUS = yes;
+      SURFACE_AGGREGATOR_CDEV = module;
+      SURFACE_AGGREGATOR_REGISTRY = module;
+
+      SURFACE_ACPI_NOTIFY = module;
+      SURFACE_DTX = module;
+      SURFACE_PLATFORM_PROFILE = module;
+
+      SURFACE_HID = module;
+      SURFACE_KBD = module;
+
+      BATTERY_SURFACE = module;
+      CHARGER_SURFACE = module;
+
+      #
+      # Surface laptop 1 keyboard
+      #
+      SERIAL_DEV_BUS = yes;
+      SERIAL_DEV_CTRL_TTYPORT = yes;
+
+      #
+      # Surface Hotplug
+      #
+      SURFACE_HOTPLUG = module;
+
+      #
+      # IPTS touchscreen
+      #
+      # This only enables the user interface for IPTS data.
+      # For the touchscreen to work, you need to install iptsd.
+      #
+      MISC_IPTS = module;
+
+      #
+      # Cameras: IPU3
+      #
+      VIDEO_IPU3_IMGU = module;
+      VIDEO_IPU3_CIO2 = module;
+      CIO2_BRIDGE = yes;
+      INTEL_SKL_INT3472 = module;
+
+      #
+      # Cameras: Sensor drivers
+      #
+      VIDEO_OV5693 = module;
+      VIDEO_OV8865 = module;
+
+      #
+      # ALS Sensor for Surface Book 3, Surface Laptop 3, Surface Pro 7
+      #
+      APDS9960 = module;
+
+      #
+      # Other Drivers
+      #
+      INPUT_SOC_BUTTON_ARRAY = module;
+      SURFACE_3_BUTTON = module;
+      SURFACE_3_POWER_OPREGION = module;
+      SURFACE_PRO3_BUTTON = module;
+      SURFACE_GPE = module;
+      SURFACE_BOOK1_DGPU_SWITCH = module;
+    };
+  }
+  {
+    name = "ms-surface/0001-surface3-oemb";
+    patch = patchDir + "/0001-surface3-oemb.patch";
+  }
+  {
+    name = "ms-surface/0002-mwifiex";
+    patch = patchDir + "/0002-mwifiex.patch";
+  }
+  {
+    name = "ms-surface/0003-ath10k";
+    patch = patchDir + "/0003-ath10k.patch";
+  }
+  {
+    name = "ms-surface/0004-ipts";
+    patch = patchDir + "/0004-ipts.patch";
+  }
+  {
+    name = "ms-surface/0005-surface-sam";
+    patch = patchDir + "/0005-surface-sam.patch";
+  }
+  {
+    name = "ms-surface/0006-surface-sam-over-hid";
+    patch = patchDir + "/0006-surface-sam-over-hid.patch";
+  }
+  {
+    name = "ms-surface/0007-surface-button";
+    patch = patchDir + "/0007-surface-button.patch";
+  }
+  {
+    name = "ms-surface/0008-surface-typecover";
+    patch = patchDir + "/0008-surface-typecover.patch";
+  }
+  {
+    name = "ms-surface/0009-surface-gpe";
+    patch = patchDir + "/0009-surface-gpe.patch";
+  }
+  {
+    name = "ms-surface/0010-cameras";
+    patch = patchDir + "/0010-cameras.patch";
+  }
+  {
+    name = "ms-surface/0011-amd-gpio";
+    patch = patchDir + "/0011-amd-gpio.patch";
+  }
+]

microsoft/surface/common/kernel/linux-6.0.17/default.nix

@@ -0,0 +1,38 @@
+{ config, lib, pkgs, ... }:
+
+let
+  inherit (lib) mkIf mkOption types;
+  inherit (pkgs) fetchurl;
+
+  inherit (pkgs.callPackage ../linux-package.nix { }) linuxPackage repos;
+
+  cfg = config.microsoft-surface;
+
+  version = "6.0.17";
+  extraMeta.branch = "6.0";
+  patchDir = repos.linux-surface + "/patches/${extraMeta.branch}";
+  kernelPatches = pkgs.callPackage ./patches.nix {
+    inherit (lib) kernel;
+    inherit version patchDir;
+  };
+
+  kernelPackages = linuxPackage {
+    inherit version extraMeta kernelPatches;
+    src = fetchurl {
+      url = "mirror://kernel/linux/kernel/v6.x/linux-${version}.tar.xz";
+      sha256 = "sha256-p+6SCSpUWbtGq/C1RJpOV+i3klkaxOesBO0lQtLOHQg=";
+    };
+  };
+
+
+in {
+  options.microsoft-surface.kernelVersion = mkOption {
+    type = types.enum [ "6.0.17" ];
+  };
+
+  config = mkIf (cfg.kernelVersion == "6.0.17") {
+    boot = {
+      inherit kernelPackages;
+    };
+  };
+}

microsoft/surface/common/kernel/linux-6.0.17/patches.nix

@@ -0,0 +1,122 @@
+{ kernel,
+  patchDir,
+  version,
+}:
+
+[
+  {
+    name = "microsoft-surface-patches-linux-${version}";
+    patch = null;
+    structuredExtraConfig = with kernel; {
+      #
+      # Surface Aggregator Module
+      #
+      CONFIG_SURFACE_AGGREGATOR = module;
+      CONFIG_SURFACE_AGGREGATOR_ERROR_INJECTION = no;
+      CONFIG_SURFACE_AGGREGATOR_BUS = yes;
+      CONFIG_SURFACE_AGGREGATOR_CDEV = module;
+      CONFIG_SURFACE_AGGREGATOR_HUB = module;
+      CONFIG_SURFACE_AGGREGATOR_REGISTRY = module;
+      CONFIG_SURFACE_AGGREGATOR_TABLET_SWITCH = module;
+
+      CONFIG_SURFACE_ACPI_NOTIFY = module;
+      CONFIG_SURFACE_DTX = module;
+      CONFIG_SURFACE_PLATFORM_PROFILE = module;
+
+      CONFIG_SURFACE_HID = module;
+      CONFIG_SURFACE_KBD = module;
+
+      CONFIG_BATTERY_SURFACE = module;
+      CONFIG_CHARGER_SURFACE = module;
+
+      #
+      # Surface Hotplug
+      #
+      CONFIG_SURFACE_HOTPLUG = module;
+
+      #
+      # IPTS touchscreen
+      #
+      # This only enables the user interface for IPTS data.
+      # For the touchscreen to work, you need to install iptsd.
+      #
+      CONFIG_MISC_IPTS = module;
+
+      #
+      # Cameras: IPU3
+      #
+      CONFIG_VIDEO_DW9719 = module;
+      CONFIG_VIDEO_IPU3_IMGU = module;
+      CONFIG_VIDEO_IPU3_CIO2 = module;
+      CONFIG_CIO2_BRIDGE = yes;
+      CONFIG_INTEL_SKL_INT3472 = module;
+      CONFIG_REGULATOR_TPS68470 = module;
+      CONFIG_COMMON_CLK_TPS68470 = module;
+
+      #
+      # Cameras: Sensor drivers
+      #
+      CONFIG_VIDEO_OV5693 = module;
+      CONFIG_VIDEO_OV7251 = module;
+      CONFIG_VIDEO_OV8865 = module;
+
+      #
+      # ALS Sensor for Surface Book 3, Surface Laptop 3, Surface Pro 7
+      #
+      CONFIG_APDS9960 = module;
+
+      #
+      # Other Drivers
+      #
+      CONFIG_INPUT_SOC_BUTTON_ARRAY = module;
+      CONFIG_SURFACE_3_POWER_OPREGION = module;
+      CONFIG_SURFACE_PRO3_BUTTON = module;
+      CONFIG_SURFACE_GPE = module;
+      CONFIG_SURFACE_BOOK1_DGPU_SWITCH = module;
+    };
+  }
+  {
+    name = "ms-surface/0001-surface3-oemb";
+    patch = patchDir + "/0001-surface3-oemb.patch";
+  }
+  {
+    name = "ms-surface/0002-mwifiex";
+    patch = patchDir + "/0002-mwifiex.patch";
+  }
+  {
+    name = "ms-surface/0003-ath10k";
+    patch = patchDir + "/0003-ath10k.patch";
+  }
+  {
+    name = "ms-surface/0004-ipts";
+    patch = patchDir + "/0004-ipts.patch";
+  }
+  {
+    name = "ms-surface/0005-surface-sam";
+    patch = patchDir + "/0005-surface-sam.patch";
+  }
+  {
+    name = "ms-surface/0006-surface-sam-over-hid";
+    patch = patchDir + "/0006-surface-sam-over-hid.patch";
+  }
+  {
+    name = "ms-surface/0007-surface-button";
+    patch = patchDir + "/0007-surface-button.patch";
+  }
+  {
+    name = "ms-surface/0008-surface-typecover";
+    patch = patchDir + "/0008-surface-typecover.patch";
+  }
+  {
+    name = "ms-surface/0009-cameras";
+    patch = patchDir + "/0009-cameras.patch";
+  }
+  {
+    name = "ms-surface/0010-amd-gpio";
+    patch = patchDir + "/0010-amd-gpio.patch";
+  }
+  {
+    name = "ms-surface/0011-rtc";
+    patch = patchDir + "/0011-rtc.patch";
+  }
+]

microsoft/surface/common/kernel/linux-6.1.3/default.nix

@@ -0,0 +1,38 @@
+{ config, lib, pkgs, ... }:
+
+let
+  inherit (lib) mkIf mkOption types;
+  inherit (pkgs) fetchurl;
+
+  inherit (pkgs.callPackage ../linux-package.nix { }) linuxPackage repos;
+
+  cfg = config.microsoft-surface;
+
+  version = "6.1.3";
+  extraMeta.branch = "6.1";
+  patchDir = repos.linux-surface + "/patches/${extraMeta.branch}";
+  kernelPatches = pkgs.callPackage ./patches.nix {
+    inherit (lib) kernel;
+    inherit version patchDir;
+  };
+
+  kernelPackages = linuxPackage {
+    inherit version extraMeta kernelPatches;
+    src = fetchurl {
+      url = "mirror://kernel/linux/kernel/v6.x/linux-${version}.tar.xz";
+      sha256 = "sha256-bcia56dRPkM8WXxzRu1/9L/RFepDo7XiemvbOMVYAxc=";
+    };
+  };
+
+
+in {
+  options.microsoft-surface.kernelVersion = mkOption {
+    type = types.enum [ "6.1.3" ];
+  };
+
+  config = mkIf (cfg.kernelVersion == "6.1.3") {
+    boot = {
+      inherit kernelPackages;
+    };
+  };
+}

microsoft/surface/common/kernel/linux-6.1.3/patches.nix

@@ -0,0 +1,122 @@
+{ kernel,
+  patchDir,
+  version,
+}:
+
+[
+  {
+    name = "microsoft-surface-patches-linux-${version}";
+    patch = null;
+    structuredExtraConfig = with kernel; {
+      #
+      # Surface Aggregator Module
+      #
+      CONFIG_SURFACE_AGGREGATOR = module;
+      CONFIG_SURFACE_AGGREGATOR_ERROR_INJECTION = no;
+      CONFIG_SURFACE_AGGREGATOR_BUS = yes;
+      CONFIG_SURFACE_AGGREGATOR_CDEV = module;
+      CONFIG_SURFACE_AGGREGATOR_HUB = module;
+      CONFIG_SURFACE_AGGREGATOR_REGISTRY = module;
+      CONFIG_SURFACE_AGGREGATOR_TABLET_SWITCH = module;
+
+      CONFIG_SURFACE_ACPI_NOTIFY = module;
+      CONFIG_SURFACE_DTX = module;
+      CONFIG_SURFACE_PLATFORM_PROFILE = module;
+
+      CONFIG_SURFACE_HID = module;
+      CONFIG_SURFACE_KBD = module;
+
+      CONFIG_BATTERY_SURFACE = module;
+      CONFIG_CHARGER_SURFACE = module;
+
+      #
+      # Surface Hotplug
+      #
+      CONFIG_SURFACE_HOTPLUG = module;
+
+      #
+      # IPTS touchscreen
+      #
+      # This only enables the user interface for IPTS data.
+      # For the touchscreen to work, you need to install iptsd.
+      #
+      CONFIG_MISC_IPTS = module;
+
+      #
+      # Cameras: IPU3
+      #
+      CONFIG_VIDEO_DW9719 = module;
+      CONFIG_VIDEO_IPU3_IMGU = module;
+      CONFIG_VIDEO_IPU3_CIO2 = module;
+      CONFIG_CIO2_BRIDGE = yes;
+      CONFIG_INTEL_SKL_INT3472 = module;
+      CONFIG_REGULATOR_TPS68470 = module;
+      CONFIG_COMMON_CLK_TPS68470 = module;
+
+      #
+      # Cameras: Sensor drivers
+      #
+      CONFIG_VIDEO_OV5693 = module;
+      CONFIG_VIDEO_OV7251 = module;
+      CONFIG_VIDEO_OV8865 = module;
+
+      #
+      # ALS Sensor for Surface Book 3, Surface Laptop 3, Surface Pro 7
+      #
+      CONFIG_APDS9960 = module;
+
+      #
+      # Other Drivers
+      #
+      CONFIG_INPUT_SOC_BUTTON_ARRAY = module;
+      CONFIG_SURFACE_3_POWER_OPREGION = module;
+      CONFIG_SURFACE_PRO3_BUTTON = module;
+      CONFIG_SURFACE_GPE = module;
+      CONFIG_SURFACE_BOOK1_DGPU_SWITCH = module;
+    };
+  }
+  {
+    name = "ms-surface/0001-surface3-oemb";
+    patch = patchDir + "/0001-surface3-oemb.patch";
+  }
+  {
+    name = "ms-surface/0002-mwifiex";
+    patch = patchDir + "/0002-mwifiex.patch";
+  }
+  {
+    name = "ms-surface/0003-ath10k";
+    patch = patchDir + "/0003-ath10k.patch";
+  }
+  {
+    name = "ms-surface/0004-ipts";
+    patch = patchDir + "/0004-ipts.patch";
+  }
+  {
+    name = "ms-surface/0005-surface-sam";
+    patch = patchDir + "/0005-surface-sam.patch";
+  }
+  {
+    name = "ms-surface/0006-surface-sam-over-hid";
+    patch = patchDir + "/0006-surface-sam-over-hid.patch";
+  }
+  {
+    name = "ms-surface/0007-surface-button";
+    patch = patchDir + "/0007-surface-button.patch";
+  }
+  {
+    name = "ms-surface/0008-surface-typecover";
+    patch = patchDir + "/0008-surface-typecover.patch";
+  }
+  {
+    name = "ms-surface/0009-cameras";
+    patch = patchDir + "/0009-cameras.patch";
+  }
+  {
+    name = "ms-surface/0010-amd-gpio";
+    patch = patchDir + "/0010-amd-gpio.patch";
+  }
+  {
+    name = "ms-surface/0011-rtc";
+    patch = patchDir + "/0011-rtc.patch";
+  }
+]

microsoft/surface/common/kernel/linux-package.nix

@@ -0,0 +1,22 @@
+{ lib,
+  buildLinux,
+  callPackage,
+  linuxPackagesFor,
+}:
+
+let
+  inherit (lib) recurseIntoAttrs;
+
+in {
+  repos = callPackage ../repos.nix {};
+
+  linuxPackage =
+    { version,
+      modDirVersion ? version,
+      ...
+    } @ args:
+    let
+      buildLinux' = buildLinux (args // { inherit modDirVersion; });
+      linuxPackagesFor' = linuxPackagesFor buildLinux';
+    in recurseIntoAttrs linuxPackagesFor';
+}

microsoft/surface/common/repos.nix

@@ -0,0 +1,32 @@
+{ fetchFromGitHub }:
+
+{
+  linux-surface = fetchFromGitHub {
+    owner = "linux-surface";
+    repo = "linux-surface";
+    rev = "487e64047ca047dde9a062909a87410e7bb86845";
+    sha256 = "sha256-HTIuRBZk0prhUPd2KnsXGo+ZyBsMwERN7P8WJH1RG3M=";
+  };
+
+  # This is the owner and repo for the pre-patched kernel from the "linux-surface" project:
+  linux-surface-kernel = { rev, sha256 }:
+    fetchFromGitHub {
+      owner = "linux-surface";
+      repo = "kernel";
+      inherit rev sha256;
+    };
+
+  ath10k-firmware = fetchFromGitHub {
+    owner = "kvalo";
+    repo = "ath10k-firmware";
+    rev = "c987e38cbdb90dcb4e477d5dd21de66c77996435";
+    sha256 = "16a67baxlga8vb43zbby2s7kpp4488vczg3manmr9g3wxnhhb9n3";
+  };
+
+  surface-go-ath10k-firmware_backup = fetchFromGitHub {
+    owner = "mexisme";
+    repo = "linux-surface_ath10k-firmware";
+    rev = "74e5409e699383d6ca2bc4da4a8433d16f3850b1";
+    sha256 = "169vgvxpgad9anmchs22fj5qm6ahzjfdnwhd8pc280q705vx6pjk";
+  };
+}

microsoft/surface/common/surface-control/default.nix

@@ -0,0 +1,25 @@
+{ config, lib, pkgs, ... }:
+
+
+let
+  inherit (lib) mkDefault mkEnableOption mkIf mkMerge;
+
+  cfg = config.microsoft-surface.surface-control;
+
+in {
+  options.microsoft-surface.surface-control = {
+    enable = mkEnableOption "Enable 'surface-control' for Microsoft Surface";
+  };
+
+  config = mkMerge [
+    {
+      microsoft-surface.surface-control.enable = mkDefault false;
+    }
+
+    (mkIf cfg.enable {
+      environment.systemPackages = with pkgs; [ surface-control ];
+      services.udev.packages = with pkgs; [ surface-control];
+      users.groups.surface-control = { };
+    })
+  ];
+}