diff --git a/microsoft/surface/default.nix b/microsoft/surface/default.nix index 56dfd07..9a59e9f 100644 --- a/microsoft/surface/default.nix +++ b/microsoft/surface/default.nix @@ -1,10 +1,17 @@ -{ config, lib, pkgs, ... }: { +{ config, lib, pkgs, ... }: + +let + inherit (lib) mkDefault; + +in { imports = [ ./kernel ./firmware/surface-go/ath10k ]; - boot.extraModprobeConfig = lib.mkDefault '' + microsoft-surface.kernelVersion = mkDefault "6.0.11"; + + boot.extraModprobeConfig = mkDefault '' options i915 enable_fbc=1 enable_rc6=1 modeset=1 options snd_hda_intel power_save=1 options snd_ac97_codec power_save=1 @@ -15,18 +22,25 @@ boot.kernelParams = [ "mem_sleep_default=deep" ]; # NOTE: Check the README before enabling TLP: - services.tlp.enable = lib.mkDefault false; + services.tlp.enable = mkDefault false; # i.e. needed for wifi firmware, see https://github.com/NixOS/nixos-hardware/issues/364 - hardware.enableRedistributableFirmware = lib.mkDefault true; - hardware.sensor.iio.enable = lib.mkDefault true; + hardware.enableRedistributableFirmware = mkDefault true; + hardware.sensor.iio.enable = mkDefault true; - environment.systemPackages = with pkgs; [ surface-control ]; + environment.systemPackages = [ + pkgs.surface-control + ]; users.groups.surface-control = { }; - services.udev.packages = [ pkgs.surface-control ]; + services.udev.packages = [ + pkgs.surface-control + ]; + systemd.services.iptsd = { description = "IPTSD"; script = "${pkgs.iptsd}/bin/iptsd"; - wantedBy = [ "multi-user.target" ]; + wantedBy = [ + "multi-user.target" + ]; }; } diff --git a/microsoft/surface/firmware/surface-go/ath10k/ath10k-replace.nix b/microsoft/surface/firmware/surface-go/ath10k/ath10k-replace.nix index be0e4fe..e62307d 100644 --- a/microsoft/surface/firmware/surface-go/ath10k/ath10k-replace.nix +++ b/microsoft/surface/firmware/surface-go/ath10k/ath10k-replace.nix @@ -1,9 +1,10 @@ -{stdenv, lib, pkgs, firmwareLinuxNonfree, ...}: +{ stdenv, lib, pkgs, firmwareLinuxNonfree, ... }: + let repos = (pkgs.callPackage ../../../repos.nix {}); killernetworking_firmware = repos.surface-go-ath10k-firmware_backup + "/K1535_Debian"; -in -stdenv.mkDerivation { + +in stdenv.mkDerivation { pname = "microsoft-surface-go-firmware-linux-nonfree"; inherit (firmwareLinuxNonfree) version; src = firmwareLinuxNonfree; diff --git a/microsoft/surface/firmware/surface-go/ath10k/default.nix b/microsoft/surface/firmware/surface-go/ath10k/default.nix index b23fe2e..f861f8e 100644 --- a/microsoft/surface/firmware/surface-go/ath10k/default.nix +++ b/microsoft/surface/firmware/surface-go/ath10k/default.nix @@ -1,21 +1,24 @@ { config, lib, pkgs, ... }: + let + inherit (lib) mkDefault mkEnableOption mkIf; + cfg = config.hardware.microsoft-surface.firmware.surface-go-ath10k; -in -{ + +in { options = { hardware.microsoft-surface.firmware.surface-go-ath10k = { - replace = lib.mkEnableOption ''Use the "board.bin" firmware for ath10k-based WiFi on Surface Go.''; + replace = mkEnableOption ''Use the "board.bin" firmware for ath10k-based WiFi on Surface Go.''; }; }; - config = lib.mkIf cfg.replace { + config = mkIf cfg.replace { hardware.enableAllFirmware = true; hardware.firmware = [ (pkgs.callPackage ./ath10k-replace.nix {}) ]; - boot.extraModprobeConfig = lib.mkDefault '' + boot.extraModprobeConfig = mkDefault '' options ath10k_core skip_otp=Y ''; }; diff --git a/microsoft/surface/kernel/default.nix b/microsoft/surface/kernel/default.nix index 0f23cf6..4fc495f 100644 --- a/microsoft/surface/kernel/default.nix +++ b/microsoft/surface/kernel/default.nix @@ -1,5 +1,16 @@ { config, lib, pkgs, ... }: -{ - boot.kernelPackages = pkgs.callPackage ./linux-5.19.17 { }; +let + inherit (lib) mkOption types; + +in { + imports = [ + ./linux-5.19.17 + ./linux-6.0.11 + ]; + + options.microsoft-surface.kernelVersion = mkOption { + description = "Kernel Version to use (patched for MS Surface)"; + type = types.enum [ ]; + }; } diff --git a/microsoft/surface/kernel/linux-5.19.17/default.nix b/microsoft/surface/kernel/linux-5.19.17/default.nix index 1be2724..6cc1830 100644 --- a/microsoft/surface/kernel/linux-5.19.17/default.nix +++ b/microsoft/surface/kernel/linux-5.19.17/default.nix @@ -1,126 +1,37 @@ { config, lib, pkgs, ... }: + let - repos = (pkgs.callPackage ../../repos.nix { }); - patches = repos.linux-surface + "/patches"; - surface_kernelPatches = [ - { - name = "microsoft-surface-patches-linux-5.19.17"; - patch = null; - structuredExtraConfig = with lib.kernel; { - # - # Surface Aggregator Module - # - SURFACE_AGGREGATOR = module; - SURFACE_AGGREGATOR_ERROR_INJECTION = no; - SURFACE_AGGREGATOR_BUS = yes; - SURFACE_AGGREGATOR_CDEV = module; - SURFACE_AGGREGATOR_REGISTRY = module; + inherit (lib) mkIf mkOption types; + inherit (pkgs) fetchurl; - SURFACE_ACPI_NOTIFY = module; - SURFACE_DTX = module; - SURFACE_PLATFORM_PROFILE = module; + inherit (pkgs.callPackage ../linux-package.nix { }) linuxPackage repos; - SURFACE_HID = module; - SURFACE_KBD = module; + cfg = config.microsoft-surface; - BATTERY_SURFACE = module; - CHARGER_SURFACE = module; - - # - # Surface laptop 1 keyboard - # - SERIAL_DEV_BUS = yes; - SERIAL_DEV_CTRL_TTYPORT = yes; + 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; + }; - # - # Surface Hotplug - # - SURFACE_HOTPLUG = module; + kernelPackages = linuxPackage { + inherit version extraMeta kernelPatches; + src = fetchurl { + url = "mirror://kernel/linux/kernel/v5.x/linux-${version}.tar.xz"; + sha256 = "sha256-yTuzhKl60fCk8Y5ELOApEkJyL3gCPspliyI0RUHwlIk="; + }; + }; - # - # IPTS touchscreen - # - # This only enables the user interface for IPTS data. - # For the touchscreen to work, you need to install iptsd. - # - MISC_IPTS = module; +in { + options.microsoft-surface.kernelVersion = mkOption { + type = types.enum [ "5.19.17" ]; + }; - # - # 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 = patches + "/5.19/0001-surface3-oemb.patch"; - } - { - name = "ms-surface/0002-mwifiex"; - patch = patches + "/5.19/0002-mwifiex.patch"; - } - { - name = "ms-surface/0003-ath10k"; - patch = patches + "/5.19/0003-ath10k.patch"; - } - { - name = "ms-surface/0004-ipts"; - patch = patches + "/5.19/0004-ipts.patch"; - } - { - name = "ms-surface/0005-surface-sam"; - patch = patches + "/5.19/0005-surface-sam.patch"; - } - { - name = "ms-surface/0006-surface-sam-over-hid"; - patch = patches + "/5.19/0006-surface-sam-over-hid.patch"; - } - { - name = "ms-surface/0007-surface-button"; - patch = patches + "/5.19/0007-surface-button.patch"; - } - { - name = "ms-surface/0008-surface-typecover"; - patch = patches + "/5.19/0008-surface-typecover.patch"; - } - { - name = "ms-surface/0009-surface-gpe"; - patch = patches + "/5.19/0009-surface-gpe.patch"; - } - { - name = "ms-surface/0010-cameras"; - patch = patches + "/5.19/0010-cameras.patch"; - } - { - name = "ms-surface/0011-amd-gpio"; - patch = patches + "/5.19/0011-amd-gpio.patch"; - } - ]; -in (with pkgs; - recurseIntoAttrs (linuxPackagesFor (callPackage ./linux-5.19.17.nix { - kernelPatches = surface_kernelPatches; - }))) + config = mkIf (cfg.kernelVersion == "5.19.17") { + boot = { + inherit kernelPackages; + }; + }; +} diff --git a/microsoft/surface/kernel/linux-5.19.17/linux-5.19.17.nix b/microsoft/surface/kernel/linux-5.19.17/linux-5.19.17.nix deleted file mode 100644 index 6cc725e..0000000 --- a/microsoft/surface/kernel/linux-5.19.17/linux-5.19.17.nix +++ /dev/null @@ -1,22 +0,0 @@ -{ lib, stdenv, buildPackages, fetchurl, perl, buildLinux -, modDirVersionArg ? null, ... }@args: - -with lib; - -buildLinux (args // rec { - version = "5.19.17"; - - # modDirVersion needs to be x.y.z, will automatically add .0 if needed - modDirVersion = if (modDirVersionArg == null) then - concatStringsSep "." (take 3 (splitVersion "${version}.0")) - else - modDirVersionArg; - - # branchVersion needs to be x.y - extraMeta.branch = versions.majorMinor version; - - src = fetchurl { - url = "mirror://kernel/linux/kernel/v5.x/linux-${version}.tar.xz"; - sha256 = "sha256-yTuzhKl60fCk8Y5ELOApEkJyL3gCPspliyI0RUHwlIk="; - }; -} // (args.argsOverride or { })) diff --git a/microsoft/surface/kernel/linux-5.19.17/patches.nix b/microsoft/surface/kernel/linux-5.19.17/patches.nix new file mode 100644 index 0000000..86a7141 --- /dev/null +++ b/microsoft/surface/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"; + } +] diff --git a/microsoft/surface/kernel/linux-6.0.11/default.nix b/microsoft/surface/kernel/linux-6.0.11/default.nix new file mode 100644 index 0000000..652f241 --- /dev/null +++ b/microsoft/surface/kernel/linux-6.0.11/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.11"; + 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-K65hMeZJceHjT/OV+lQpcRNMhXvbCykGmrhHx8mpx2I="; + }; + }; + + +in { + options.microsoft-surface.kernelVersion = mkOption { + type = types.enum [ "6.0.11" ]; + }; + + config = mkIf (cfg.kernelVersion == "6.0.11") { + boot = { + inherit kernelPackages; + }; + }; +} diff --git a/microsoft/surface/kernel/linux-6.0.11/patches.nix b/microsoft/surface/kernel/linux-6.0.11/patches.nix new file mode 100644 index 0000000..e111c26 --- /dev/null +++ b/microsoft/surface/kernel/linux-6.0.11/patches.nix @@ -0,0 +1,118 @@ +{ 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"; + # } +] diff --git a/microsoft/surface/kernel/linux-package.nix b/microsoft/surface/kernel/linux-package.nix new file mode 100644 index 0000000..4858e4f --- /dev/null +++ b/microsoft/surface/kernel/linux-package.nix @@ -0,0 +1,23 @@ +{ lib, + buildLinux, + callPackage, + fetchurl, + linuxPackagesFor, +}: + +let + inherit (lib) kernel recurseIntoAttrs; + +in { + repos = callPackage ../repos.nix {}; + + linuxPackage = + { version, + modDirVersion ? version, + ... + } @ args: + let + buildLinux' = buildLinux (args // { inherit modDirVersion; }); + linuxPackagesFor' = linuxPackagesFor buildLinux'; + in recurseIntoAttrs linuxPackagesFor'; +} diff --git a/microsoft/surface/repos.nix b/microsoft/surface/repos.nix index c2feeb3..0e58c0c 100644 --- a/microsoft/surface/repos.nix +++ b/microsoft/surface/repos.nix @@ -1,11 +1,21 @@ -{ lib, pkgs, fetchFromGitHub, fetchurl }: { +{ fetchFromGitHub, fetchurl }: + +{ linux-surface = fetchFromGitHub { owner = "linux-surface"; repo = "linux-surface"; - rev = "fe2bed0f88a1803d87cd1805dc81272be32844ae"; - sha256 = "sha256-sOJ4oN1F+/bNrGcqxh2IG4rn6twu//TExnn+qmQPW/0="; + rev = "8995c6b3b4fb659397f4ebc760c6ac8b5efc5488"; + sha256 = "sha256-r7nbW0WKmvw7mMZL1BzuFwgwftyN5FIfP5xLDiQMEiI="; }; + # 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";