From 8141742b12ab3ff3d4769640dad1e1abeeda6171 Mon Sep 17 00:00:00 2001 From: Andre Date: Thu, 10 Apr 2025 20:37:04 -0400 Subject: [PATCH 1/9] microsoft/surface: add kernel switching for LTS and latest kernels --- microsoft/surface/common/default.nix | 66 ++++++-- .../{linux-surface => 6.12}/patches.nix | 0 .../surface/common/kernel/6.13/patches.nix | 157 ++++++++++++++++++ microsoft/surface/common/kernel/default.nix | 15 -- .../surface/common/kernel/linux-package.nix | 3 +- .../common/kernel/linux-surface/default.nix | 31 ---- microsoft/surface/common/kernel/repos.nix | 9 + microsoft/surface/common/repos.nix | 25 --- .../firmware/ath10k/ath10k-replace.nix | 9 +- 9 files changed, 228 insertions(+), 87 deletions(-) rename microsoft/surface/common/kernel/{linux-surface => 6.12}/patches.nix (100%) create mode 100644 microsoft/surface/common/kernel/6.13/patches.nix delete mode 100644 microsoft/surface/common/kernel/default.nix delete mode 100644 microsoft/surface/common/kernel/linux-surface/default.nix create mode 100644 microsoft/surface/common/kernel/repos.nix delete mode 100644 microsoft/surface/common/repos.nix diff --git a/microsoft/surface/common/default.nix b/microsoft/surface/common/default.nix index d49f4e312..fe3a41edc 100644 --- a/microsoft/surface/common/default.nix +++ b/microsoft/surface/common/default.nix @@ -1,22 +1,62 @@ -{ lib, ... }: +{ config, lib, pkgs, ... }: let - inherit (lib) mkDefault; + inherit (lib) mkDefault mkOption types; + + version = config.microsoft-surface.kernelVersion; + rev = + if version == "6.12" then + "arch-6.12.19-1" + else if version == "6.13" then + "arch-6.13.6-1" + else + abort "Invalid kernel version: ${version}"; + + hash = + if version == "6.12" then + "sha256-Pv7O8D8ma+MPLhYP3HSGQki+Yczp8b7d63qMb6l4+mY=" + else if version == "6.13" then + "sha256-otD1ckNxNnvV8xipf9SZpbfg+bBq5EPwyieYtLIV4Ck=" + else + abort "Invalid kernel version: ${version}"; + + inherit (pkgs.callPackage ./kernel/linux-package.nix { repos = pkgs.callPackage ./kernel/repos.nix { rev = rev; hash = hash; }; }) linuxPackage surfacePatches; + + kernelPatches = surfacePatches { + inherit version; + patchFn = ./kernel/${version}/patches.nix; + }; + kernelPackages = linuxPackage { + inherit version kernelPatches; + sha256 = "sha256-1zvwV77ARDSxadG2FkGTb30Ml865I6KB8y413U3MZTE="; + ignoreConfigErrors=true; + }; in { - imports = [ - ./kernel - ]; + options.microsoft-surface.kernelVersion = mkOption { + description = "Kernel Version to use (patched for MS Surface)"; + type = types.enum [ + "6.12" + "6.13" + ]; + default = "6.12"; + }; - microsoft-surface.kernelVersion = mkDefault "6.12"; + config = { + boot = { + inherit kernelPackages; - # Seems to be required to properly enable S0ix "Modern Standby": - boot.kernelParams = mkDefault [ "mem_sleep_default=deep" ]; + kernelParams = mkDefault [ "mem_sleep_default=deep" ]; + # Seems to be required to properly enable S0ix "Modern Standby": + }; - # NOTE: Check the README before enabling TLP: - services.tlp.enable = mkDefault false; + # 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; + # i.e. needed for wifi firmware, see https://github.com/NixOS/nixos-hardware/issues/364 + hardware = { + enableRedistributableFirmware = mkDefault true; + sensor.iio.enable = mkDefault true; + }; + }; } diff --git a/microsoft/surface/common/kernel/linux-surface/patches.nix b/microsoft/surface/common/kernel/6.12/patches.nix similarity index 100% rename from microsoft/surface/common/kernel/linux-surface/patches.nix rename to microsoft/surface/common/kernel/6.12/patches.nix diff --git a/microsoft/surface/common/kernel/6.13/patches.nix b/microsoft/surface/common/kernel/6.13/patches.nix new file mode 100644 index 000000000..d905499f8 --- /dev/null +++ b/microsoft/surface/common/kernel/6.13/patches.nix @@ -0,0 +1,157 @@ +{ lib, + kernel ? lib.kernel, + patchSrc, + version, +}: + +[ + { + name = "microsoft-surface-patches-linux-${version}"; + patch = null; + extraStructuredConfig = with kernel; { + STAGING_MEDIA = yes; + +## +## Surface Aggregator Module +## +CONFIG_SURFACE_AGGREGATOR= module; +# CONFIG_SURFACE_AGGREGATOR_ERROR_INJECTION is not set +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; + +CONFIG_SENSORS_SURFACE_TEMP= module; +CONFIG_SENSORS_SURFACE_FAN= module; + +## +## Surface Hotplug +## +CONFIG_SURFACE_HOTPLUG= module; + +## +## IPTS and ITHC touchscreen +## +## This only enables the user interface for IPTS/ITHC data. +## For the touchscreen to work, you need to install iptsd. +## +CONFIG_HID_IPTS= module; +CONFIG_HID_ITHC= module; + +## +## Cameras: IPU3 +## +CONFIG_VIDEO_DW9719= module; +CONFIG_VIDEO_IPU3_IMGU= module; +CONFIG_VIDEO_IPU3_CIO2= module; +CONFIG_IPU_BRIDGE= module; +CONFIG_INTEL_SKL_INT3472= module; +CONFIG_REGULATOR_TPS68470= module; +CONFIG_COMMON_CLK_TPS68470= module; +CONFIG_LEDS_TPS68470= module; + +## +## Cameras: Sensor drivers +## +CONFIG_VIDEO_OV5693= module; +CONFIG_VIDEO_OV7251= module; +CONFIG_VIDEO_OV8865= module; + +## +## Surface 3: atomisp causes problems (see issue #1095). Disable it for now. +## +# CONFIG_INTEL_ATOMISP is not set + +## +## ALS Sensor for Surface Book 3, Surface Laptop 3, Surface Pro 7 +## +CONFIG_APDS9960= module; + +## +## Build-in UFS support (required for some Surface Go devices) +## +CONFIG_SCSI_UFSHCD= module; +CONFIG_SCSI_UFSHCD_PCI= 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-secureboot"; + patch = patchSrc + "/0001-secureboot.patch"; + } + { + name = "ms-surface/0002-surface3"; + patch = patchSrc + "/0002-surface3.patch"; + } + { + name = "ms-surface/0003-mwifiex"; + patch = patchSrc + "/0003-mwifiex.patch"; + } + { + name = "ms-surface/0004-ath10k"; + patch = patchSrc + "/0004-ath10k.patch"; + } + { + name = "ms-surface/0005-ipts"; + patch = patchSrc + "/0005-ipts.patch"; + } + { + name = "ms-surface/0006-ithc"; + patch = patchSrc + "/0006-ithc.patch"; + } + { + name = "ms-surface/0007-surface-sam"; + patch = patchSrc + "/0007-surface-sam.patch"; + } + { + name = "ms-surface/0008-surface-sam-over-hid"; + patch = patchSrc + "/0008-surface-sam-over-hid.patch"; + } + { + name = "ms-surface/0009-surface-button"; + patch = patchSrc + "/0009-surface-button.patch"; + } + { + name = "ms-surface/0010-surface-typecover"; + patch = patchSrc + "/0010-surface-typecover.patch"; + } + { + name = "ms-surface/0011-surface-shutdown"; + patch = patchSrc + "/0011-surface-shutdown.patch"; + } + { + name = "ms-surface/0012-surface-gpe"; + patch = patchSrc + "/0012-surface-gpe.patch"; + } + { + name = "ms-surface/0013-cameras"; + patch = patchSrc + "/0013-cameras.patch"; + } + { + name = "ms-surface/0014-amd-gpio"; + patch = patchSrc + "/0014-amd-gpio.patch"; + } + { + name = "ms-surface/0015-rtc"; + patch = patchSrc + "/0015-rtc.patch"; + } +] diff --git a/microsoft/surface/common/kernel/default.nix b/microsoft/surface/common/kernel/default.nix deleted file mode 100644 index 490ecd0da..000000000 --- a/microsoft/surface/common/kernel/default.nix +++ /dev/null @@ -1,15 +0,0 @@ -{ lib, ... }: - -let - inherit (lib) mkOption types; - -in { - imports = [ - ./linux-surface - ]; - - options.microsoft-surface.kernelVersion = mkOption { - description = "Kernel Version to use (patched for MS Surface)"; - type = types.enum [ ]; - }; -} diff --git a/microsoft/surface/common/kernel/linux-package.nix b/microsoft/surface/common/kernel/linux-package.nix index b179fcb7c..28e3e0e7c 100644 --- a/microsoft/surface/common/kernel/linux-package.nix +++ b/microsoft/surface/common/kernel/linux-package.nix @@ -3,14 +3,13 @@ fetchurl, buildLinux, linuxPackagesFor, + repos, }: let inherit (builtins) elem; inherit (lib) recurseIntoAttrs types versions; - repos = pkgs.callPackage ../repos.nix {}; - linuxPackage = { url ? "mirror://kernel/linux/kernel/v${versions.major version}.x/linux-${version}.tar.xz", sha256 ? null, diff --git a/microsoft/surface/common/kernel/linux-surface/default.nix b/microsoft/surface/common/kernel/linux-surface/default.nix deleted file mode 100644 index 5eb1e9768..000000000 --- a/microsoft/surface/common/kernel/linux-surface/default.nix +++ /dev/null @@ -1,31 +0,0 @@ -{ config, lib, pkgs, ... }: - -let - inherit (lib) mkIf mkOption; - - inherit (pkgs.callPackage ../linux-package.nix { }) linuxPackage surfacePatches isVersionOf versionsOfEnum; - - cfg = config.microsoft-surface; - - version = "6.12.19"; - kernelPatches = surfacePatches { - inherit version; - patchFn = ./patches.nix; - }; - kernelPackages = linuxPackage { - inherit version kernelPatches; - sha256 = "sha256-1zvwV77ARDSxadG2FkGTb30Ml865I6KB8y413U3MZTE="; - ignoreConfigErrors=true; - }; - -in { - options.microsoft-surface.kernelVersion = mkOption { - type = versionsOfEnum version; - }; - - config = mkIf (isVersionOf cfg.kernelVersion version) { - boot = { - inherit kernelPackages; - }; - }; -} diff --git a/microsoft/surface/common/kernel/repos.nix b/microsoft/surface/common/kernel/repos.nix new file mode 100644 index 000000000..6d8349fdd --- /dev/null +++ b/microsoft/surface/common/kernel/repos.nix @@ -0,0 +1,9 @@ +{ fetchFromGitHub, rev, hash }: +{ + linux-surface = fetchFromGitHub { + owner = "linux-surface"; + repo = "linux-surface"; + rev = rev; + hash = hash; + }; +} \ No newline at end of file diff --git a/microsoft/surface/common/repos.nix b/microsoft/surface/common/repos.nix deleted file mode 100644 index a6bb73680..000000000 --- a/microsoft/surface/common/repos.nix +++ /dev/null @@ -1,25 +0,0 @@ -{ fetchFromGitHub }: - -{ - linux-surface = fetchFromGitHub { - owner = "linux-surface"; - repo = "linux-surface"; - rev = "arch-6.12.7-1"; - hash = "sha256-Pv7O8D8ma+MPLhYP3HSGQki+Yczp8b7d63qMb6l4+mY="; - }; - - # 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; - }; - - surface-go-ath10k-firmware_backup = fetchFromGitHub { - owner = "mexisme"; - repo = "linux-surface_ath10k-firmware"; - rev = "74e5409e699383d6ca2bc4da4a8433d16f3850b1"; - sha256 = "169vgvxpgad9anmchs22fj5qm6ahzjfdnwhd8pc280q705vx6pjk"; - }; -} diff --git a/microsoft/surface/surface-go/firmware/ath10k/ath10k-replace.nix b/microsoft/surface/surface-go/firmware/ath10k/ath10k-replace.nix index 6cc55fa23..132695e51 100644 --- a/microsoft/surface/surface-go/firmware/ath10k/ath10k-replace.nix +++ b/microsoft/surface/surface-go/firmware/ath10k/ath10k-replace.nix @@ -1,7 +1,14 @@ { stdenv, lib, pkgs, firmwareLinuxNonfree, ... }: let - repos = pkgs.callPackage ../../../common/repos.nix {}; + repos = pkgs.callPackage { + surface-go-ath10k-firmware_backup = lib.fetchFromGitHub { + owner = "mexisme"; + repo = "linux-surface_ath10k-firmware"; + rev = "74e5409e699383d6ca2bc4da4a8433d16f3850b1"; + sha256 = "169vgvxpgad9anmchs22fj5qm6ahzjfdnwhd8pc280q705vx6pjk"; + }; + } {}; killernetworking_firmware = repos.surface-go-ath10k-firmware_backup + "/K1535_Debian"; in stdenv.mkDerivation { From 9726adf371a51e3f6884b190b259e8842c32e6ca Mon Sep 17 00:00:00 2001 From: Andre Date: Fri, 11 Apr 2025 09:35:36 -0400 Subject: [PATCH 2/9] microsoft/surface: add kernel source hash logic --- microsoft/surface/common/default.nix | 33 ++++++++++++++++++---------- 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/microsoft/surface/common/default.nix b/microsoft/surface/common/default.nix index fe3a41edc..2ad223329 100644 --- a/microsoft/surface/common/default.nix +++ b/microsoft/surface/common/default.nix @@ -3,32 +3,41 @@ let inherit (lib) mkDefault mkOption types; - version = config.microsoft-surface.kernelVersion; - rev = - if version == "6.12" then - "arch-6.12.19-1" - else if version == "6.13" then - "arch-6.13.6-1" + shortVersion = config.microsoft-surface.kernelVersion; + version = if shortVersion == "6.12" then + "6.12.19" + else if shortVersion == "6.13" then + "6.13.6" else - abort "Invalid kernel version: ${version}"; + abort "Invalid kernel version: ${shortVersion}"; + + rev = "arch-${version}-1"; hash = - if version == "6.12" then + if shortVersion == "6.12" then "sha256-Pv7O8D8ma+MPLhYP3HSGQki+Yczp8b7d63qMb6l4+mY=" - else if version == "6.13" then + else if shortVersion == "6.13" then "sha256-otD1ckNxNnvV8xipf9SZpbfg+bBq5EPwyieYtLIV4Ck=" else - abort "Invalid kernel version: ${version}"; + abort "Invalid kernel version: ${shortVersion}"; + + srcHash = + if shortVersion == "6.12" then + "sha256-1zvwV77ARDSxadG2FkGTb30Ml865I6KB8y413U3MZTE=" + else if shortVersion == "6.13" then + "sha256-3gBTy0E9QI8g/R1XiCGZUbikQD5drBsdkDIJCTis0Zk=" + else + abort "Invalid kernel version: ${shortVersion}"; inherit (pkgs.callPackage ./kernel/linux-package.nix { repos = pkgs.callPackage ./kernel/repos.nix { rev = rev; hash = hash; }; }) linuxPackage surfacePatches; kernelPatches = surfacePatches { inherit version; - patchFn = ./kernel/${version}/patches.nix; + patchFn = ./kernel/${shortVersion}/patches.nix; }; kernelPackages = linuxPackage { inherit version kernelPatches; - sha256 = "sha256-1zvwV77ARDSxadG2FkGTb30Ml865I6KB8y413U3MZTE="; + sha256 = srcHash; ignoreConfigErrors=true; }; From bb295c09d96dc62b24f101c98a1115552449db92 Mon Sep 17 00:00:00 2001 From: Andre Date: Fri, 11 Apr 2025 14:54:03 -0400 Subject: [PATCH 3/9] microsoft/surface: remove repos.nix file and update README --- microsoft/surface/README.md | 26 +++++++++----- microsoft/surface/common/default.nix | 41 ++++++++++++++--------- microsoft/surface/common/kernel/repos.nix | 9 ----- 3 files changed, 44 insertions(+), 32 deletions(-) delete mode 100644 microsoft/surface/common/kernel/repos.nix diff --git a/microsoft/surface/README.md b/microsoft/surface/README.md index a461f3187..508bbebce 100644 --- a/microsoft/surface/README.md +++ b/microsoft/surface/README.md @@ -1,8 +1,3 @@ -# NOTE: Structure changes from 2023-01-10 - -Please read the [Deprecated Behaviour README](./OLD-BEHAVIOUR-DEPRECATION.md) to understand how some structural changes to -the code might affect you! - # Derivations for Microsoft Surface notebooks These derivatives use the patches from the [linux-surface repo](https://github.com/linux-surface/linux-surface/tree/master/patches). @@ -32,13 +27,24 @@ Not all hardware is fully supported, but the [linux-surface feature matrix](https://github.com/linux-surface/linux-surface/wiki/Supported-Devices-and-Features#feature-matrix) provides details on which devices are supported on which types of machine. -The kernel-specific derivations are under the [`common/kernel/`](./common/kernel/) sub-directory. -In order to simplify maintenance of the Nix code, only the most-recent kernel patch-set is expected -to be maintained in this repo. +The kernel-specific derivations are under the [`common/kernel/`](./common/kernel/) sub-directory. This directory defines patch sets for each supported kernel release (see Kernel versions below for more information). _*NOTE:*_ Some built-in Kernel config items need to be set, that aren't set by default: - https://github.com/linux-surface/surface-aggregator-module/wiki/Testing-and-Installing +#### Kernel versions + +There are multiple versions of the Surface kernel available: + +- `lts`, which tracks the latest LTS release. +- `latest`, which tracks the most recent release. + +This repo uses `lts` by default, but you can switch it to `latest` by adding this to your configuration file: + +```nix +microsoft-surface.kernelVersion = "latest"; +``` + ### Support Tools ### IPTS @@ -120,3 +126,7 @@ References: - https://github.com/thebitstick/surfacego-wifi - https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/ath10k - https://wireless.wiki.kernel.org/en/users/drivers/ath10k/firmware + +## Structural changes from earlier versions (2023-01-10 and earlier) + +If you're upgrading from an older version of nixos-hardware, please read the [Deprecated Behaviour README](./OLD-BEHAVIOUR-DEPRECATION.md) to understand how some structural changes to the code might affect you! diff --git a/microsoft/surface/common/default.nix b/microsoft/surface/common/default.nix index 2ad223329..c7bd3547a 100644 --- a/microsoft/surface/common/default.nix +++ b/microsoft/surface/common/default.nix @@ -1,19 +1,19 @@ { config, lib, pkgs, ... }: let - inherit (lib) mkDefault mkOption types; + inherit (lib) fetchFromGitHub mkDefault mkOption types versions; - shortVersion = config.microsoft-surface.kernelVersion; - version = if shortVersion == "6.12" then + # Set the full kernel version and hashes + version = + if config.microsoft-surface.kernelVersion == "lts" then "6.12.19" - else if shortVersion == "6.13" then + else if config.microsoft-surface.kernelVersion == "latest" then "6.13.6" else - abort "Invalid kernel version: ${shortVersion}"; - - rev = "arch-${version}-1"; + abort "Invalid kernel version: ${config.microsoft-surface.kernelVersion}"; - hash = + shortVersion = versions.majorMinor version; + packageHash = if shortVersion == "6.12" then "sha256-Pv7O8D8ma+MPLhYP3HSGQki+Yczp8b7d63qMb6l4+mY=" else if shortVersion == "6.13" then @@ -29,15 +29,26 @@ let else abort "Invalid kernel version: ${shortVersion}"; - inherit (pkgs.callPackage ./kernel/linux-package.nix { repos = pkgs.callPackage ./kernel/repos.nix { rev = rev; hash = hash; }; }) linuxPackage surfacePatches; + # Fetch the release from the linux-surface project + rev = "arch-${version}-1"; + repos = pkgs.callPackage ({ fetchFromGitHub, rev, packageHash }: { + linux-surface = fetchFromGitHub { + owner = "linux-surface"; + repo = "linux-surface"; + rev = rev; + hash = packageHash; + }; + }) { inherit rev packageHash; }; + # Build the kernel package + inherit (pkgs.callPackage ./kernel/linux-package.nix { inherit repos; }) linuxPackage surfacePatches; kernelPatches = surfacePatches { inherit version; patchFn = ./kernel/${shortVersion}/patches.nix; }; kernelPackages = linuxPackage { inherit version kernelPatches; - sha256 = srcHash; + hash = srcHash; ignoreConfigErrors=true; }; @@ -45,24 +56,24 @@ in { options.microsoft-surface.kernelVersion = mkOption { description = "Kernel Version to use (patched for MS Surface)"; type = types.enum [ - "6.12" - "6.13" + "lts" + "latest" ]; - default = "6.12"; + default = "lts"; }; config = { boot = { inherit kernelPackages; - kernelParams = mkDefault [ "mem_sleep_default=deep" ]; # Seems to be required to properly enable S0ix "Modern Standby": + 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 + # Needed for wifi firmware, see https://github.com/NixOS/nixos-hardware/issues/364 hardware = { enableRedistributableFirmware = mkDefault true; sensor.iio.enable = mkDefault true; diff --git a/microsoft/surface/common/kernel/repos.nix b/microsoft/surface/common/kernel/repos.nix deleted file mode 100644 index 6d8349fdd..000000000 --- a/microsoft/surface/common/kernel/repos.nix +++ /dev/null @@ -1,9 +0,0 @@ -{ fetchFromGitHub, rev, hash }: -{ - linux-surface = fetchFromGitHub { - owner = "linux-surface"; - repo = "linux-surface"; - rev = rev; - hash = hash; - }; -} \ No newline at end of file From dab2104c1fe488bf5d7ef537e60378a9d9b81a34 Mon Sep 17 00:00:00 2001 From: Andre Date: Sat, 12 Apr 2025 10:37:47 -0400 Subject: [PATCH 4/9] microsoft/surface: switch back to using sha256 instead of hash due to connection breaking --- microsoft/surface/common/default.nix | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/microsoft/surface/common/default.nix b/microsoft/surface/common/default.nix index c7bd3547a..ecbdf4e7c 100644 --- a/microsoft/surface/common/default.nix +++ b/microsoft/surface/common/default.nix @@ -1,7 +1,7 @@ { config, lib, pkgs, ... }: let - inherit (lib) fetchFromGitHub mkDefault mkOption types versions; + inherit (lib) mkDefault mkOption types versions; # Set the full kernel version and hashes version = @@ -48,7 +48,7 @@ let }; kernelPackages = linuxPackage { inherit version kernelPatches; - hash = srcHash; + sha256 = srcHash; ignoreConfigErrors=true; }; From 2034c5d2e7831e8aab82e2fa21821b30767fbe8e Mon Sep 17 00:00:00 2001 From: Andre Date: Sat, 12 Apr 2025 10:42:29 -0400 Subject: [PATCH 5/9] microsoft/surface: rename 'lts' and 'latest' to 'longterm' and 'stable' --- microsoft/surface/README.md | 8 ++++---- microsoft/surface/common/default.nix | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/microsoft/surface/README.md b/microsoft/surface/README.md index 508bbebce..cc5dbde55 100644 --- a/microsoft/surface/README.md +++ b/microsoft/surface/README.md @@ -36,13 +36,13 @@ _*NOTE:*_ Some built-in Kernel config items need to be set, that aren't set by d There are multiple versions of the Surface kernel available: -- `lts`, which tracks the latest LTS release. -- `latest`, which tracks the most recent release. +- `longterm`, which tracks the latest long term support (LTS) release. +- `stable`, which tracks the most recent stable release. -This repo uses `lts` by default, but you can switch it to `latest` by adding this to your configuration file: +This repo uses `longterm` by default, but you can switch it to `stable` by adding this to your configuration file: ```nix -microsoft-surface.kernelVersion = "latest"; +microsoft-surface.kernelVersion = "stable"; ``` ### Support Tools diff --git a/microsoft/surface/common/default.nix b/microsoft/surface/common/default.nix index ecbdf4e7c..52435ec44 100644 --- a/microsoft/surface/common/default.nix +++ b/microsoft/surface/common/default.nix @@ -5,9 +5,9 @@ let # Set the full kernel version and hashes version = - if config.microsoft-surface.kernelVersion == "lts" then + if config.microsoft-surface.kernelVersion == "longterm" then "6.12.19" - else if config.microsoft-surface.kernelVersion == "latest" then + else if config.microsoft-surface.kernelVersion == "stable" then "6.13.6" else abort "Invalid kernel version: ${config.microsoft-surface.kernelVersion}"; @@ -56,10 +56,10 @@ in { options.microsoft-surface.kernelVersion = mkOption { description = "Kernel Version to use (patched for MS Surface)"; type = types.enum [ - "lts" - "latest" + "longterm" + "stable" ]; - default = "lts"; + default = "longterm"; }; config = { From 33aa2d8399259a2b761ebc52815566b7654ff1c9 Mon Sep 17 00:00:00 2001 From: Andre Date: Sat, 12 Apr 2025 11:28:09 -0400 Subject: [PATCH 6/9] microsoft/surface: decouple kernel source and linux-surface package versions --- microsoft/surface/common/default.nix | 61 ++++++++++++++++------------ 1 file changed, 34 insertions(+), 27 deletions(-) diff --git a/microsoft/surface/common/default.nix b/microsoft/surface/common/default.nix index 52435ec44..f40de69ef 100644 --- a/microsoft/surface/common/default.nix +++ b/microsoft/surface/common/default.nix @@ -3,51 +3,58 @@ let inherit (lib) mkDefault mkOption types versions; - # Set the full kernel version and hashes - version = - if config.microsoft-surface.kernelVersion == "longterm" then + # Set the version and hash for the kernel sources + srcVersion = with config.microsoft-surface; + if kernelVersion == "longterm" then "6.12.19" - else if config.microsoft-surface.kernelVersion == "stable" then + else if kernelVersion == "stable" then "6.13.6" else - abort "Invalid kernel version: ${config.microsoft-surface.kernelVersion}"; - - shortVersion = versions.majorMinor version; - packageHash = - if shortVersion == "6.12" then - "sha256-Pv7O8D8ma+MPLhYP3HSGQki+Yczp8b7d63qMb6l4+mY=" - else if shortVersion == "6.13" then - "sha256-otD1ckNxNnvV8xipf9SZpbfg+bBq5EPwyieYtLIV4Ck=" - else - abort "Invalid kernel version: ${shortVersion}"; + abort "Invalid kernel version: ${kernelVersion}"; - srcHash = - if shortVersion == "6.12" then + srcHash = with config.microsoft-surface; + if kernelVersion == "longterm" then "sha256-1zvwV77ARDSxadG2FkGTb30Ml865I6KB8y413U3MZTE=" - else if shortVersion == "6.13" then + else if kernelVersion == "stable" then "sha256-3gBTy0E9QI8g/R1XiCGZUbikQD5drBsdkDIJCTis0Zk=" else - abort "Invalid kernel version: ${shortVersion}"; + abort "Invalid kernel version: ${kernelVersion}"; + + # Set the version and hash for the linux-surface releases + pkgVersion = with config.microsoft-surface; + if kernelVersion == "longterm" then + "6.12.7" + else if kernelVersion == "stable" then + "6.13.6" + else + abort "Invalid kernel version: ${kernelVersion}"; + + pkgHash = with config.microsoft-surface; + if kernelVersion == "longterm" then + "sha256-Pv7O8D8ma+MPLhYP3HSGQki+Yczp8b7d63qMb6l4+mY=" + else if kernelVersion == "stable" then + "sha256-otD1ckNxNnvV8xipf9SZpbfg+bBq5EPwyieYtLIV4Ck=" + else + abort "Invalid kernel version: ${kernelVersion}"; - # Fetch the release from the linux-surface project - rev = "arch-${version}-1"; - repos = pkgs.callPackage ({ fetchFromGitHub, rev, packageHash }: { + # Fetch the linux-surface package + repos = pkgs.callPackage ({ fetchFromGitHub, rev, hash }: { linux-surface = fetchFromGitHub { owner = "linux-surface"; repo = "linux-surface"; rev = rev; - hash = packageHash; + hash = hash; }; - }) { inherit rev packageHash; }; + }) { hash = pkgHash; rev = "arch-${pkgVersion}-1"; }; - # Build the kernel package + # Fetch and build the kernel package inherit (pkgs.callPackage ./kernel/linux-package.nix { inherit repos; }) linuxPackage surfacePatches; kernelPatches = surfacePatches { - inherit version; - patchFn = ./kernel/${shortVersion}/patches.nix; + version = pkgVersion; + patchFn = ./kernel/${versions.majorMinor pkgVersion}/patches.nix; }; kernelPackages = linuxPackage { - inherit version kernelPatches; + inherit kernelPatches; version = srcVersion; sha256 = srcHash; ignoreConfigErrors=true; }; From 0012cffb692c640807d1f19b395502499cc9d80b Mon Sep 17 00:00:00 2001 From: Andre Date: Sun, 20 Apr 2025 12:08:18 -0400 Subject: [PATCH 7/9] microsoft/surface: update stable linux-surface to 6.14.2 --- microsoft/surface/common/default.nix | 12 +- .../surface/common/kernel/6.13/patches.nix | 157 ----------------- .../surface/common/kernel/6.14/patches.nix | 158 ++++++++++++++++++ 3 files changed, 164 insertions(+), 163 deletions(-) delete mode 100644 microsoft/surface/common/kernel/6.13/patches.nix create mode 100644 microsoft/surface/common/kernel/6.14/patches.nix diff --git a/microsoft/surface/common/default.nix b/microsoft/surface/common/default.nix index f40de69ef..09fa344a6 100644 --- a/microsoft/surface/common/default.nix +++ b/microsoft/surface/common/default.nix @@ -6,17 +6,17 @@ let # Set the version and hash for the kernel sources srcVersion = with config.microsoft-surface; if kernelVersion == "longterm" then - "6.12.19" + "6.12.22" else if kernelVersion == "stable" then - "6.13.6" + "6.14.2" else abort "Invalid kernel version: ${kernelVersion}"; srcHash = with config.microsoft-surface; if kernelVersion == "longterm" then - "sha256-1zvwV77ARDSxadG2FkGTb30Ml865I6KB8y413U3MZTE=" + "sha256-q0iACrSZhaeNIxiuisXyj9PhI+oXNX7yFJgQWlMzczY=" else if kernelVersion == "stable" then - "sha256-3gBTy0E9QI8g/R1XiCGZUbikQD5drBsdkDIJCTis0Zk=" + "sha256-xcaCo1TqMZATk1elfTSnnlw3IhrOgjqTjhARa1d6Lhs=" else abort "Invalid kernel version: ${kernelVersion}"; @@ -25,7 +25,7 @@ let if kernelVersion == "longterm" then "6.12.7" else if kernelVersion == "stable" then - "6.13.6" + "6.14.2" else abort "Invalid kernel version: ${kernelVersion}"; @@ -33,7 +33,7 @@ let if kernelVersion == "longterm" then "sha256-Pv7O8D8ma+MPLhYP3HSGQki+Yczp8b7d63qMb6l4+mY=" else if kernelVersion == "stable" then - "sha256-otD1ckNxNnvV8xipf9SZpbfg+bBq5EPwyieYtLIV4Ck=" + "sha256-Pzn+C52TtDcqDVepM5z2cVNCsnRDy0Wwn+FLwgsuicQ=" else abort "Invalid kernel version: ${kernelVersion}"; diff --git a/microsoft/surface/common/kernel/6.13/patches.nix b/microsoft/surface/common/kernel/6.13/patches.nix deleted file mode 100644 index d905499f8..000000000 --- a/microsoft/surface/common/kernel/6.13/patches.nix +++ /dev/null @@ -1,157 +0,0 @@ -{ lib, - kernel ? lib.kernel, - patchSrc, - version, -}: - -[ - { - name = "microsoft-surface-patches-linux-${version}"; - patch = null; - extraStructuredConfig = with kernel; { - STAGING_MEDIA = yes; - -## -## Surface Aggregator Module -## -CONFIG_SURFACE_AGGREGATOR= module; -# CONFIG_SURFACE_AGGREGATOR_ERROR_INJECTION is not set -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; - -CONFIG_SENSORS_SURFACE_TEMP= module; -CONFIG_SENSORS_SURFACE_FAN= module; - -## -## Surface Hotplug -## -CONFIG_SURFACE_HOTPLUG= module; - -## -## IPTS and ITHC touchscreen -## -## This only enables the user interface for IPTS/ITHC data. -## For the touchscreen to work, you need to install iptsd. -## -CONFIG_HID_IPTS= module; -CONFIG_HID_ITHC= module; - -## -## Cameras: IPU3 -## -CONFIG_VIDEO_DW9719= module; -CONFIG_VIDEO_IPU3_IMGU= module; -CONFIG_VIDEO_IPU3_CIO2= module; -CONFIG_IPU_BRIDGE= module; -CONFIG_INTEL_SKL_INT3472= module; -CONFIG_REGULATOR_TPS68470= module; -CONFIG_COMMON_CLK_TPS68470= module; -CONFIG_LEDS_TPS68470= module; - -## -## Cameras: Sensor drivers -## -CONFIG_VIDEO_OV5693= module; -CONFIG_VIDEO_OV7251= module; -CONFIG_VIDEO_OV8865= module; - -## -## Surface 3: atomisp causes problems (see issue #1095). Disable it for now. -## -# CONFIG_INTEL_ATOMISP is not set - -## -## ALS Sensor for Surface Book 3, Surface Laptop 3, Surface Pro 7 -## -CONFIG_APDS9960= module; - -## -## Build-in UFS support (required for some Surface Go devices) -## -CONFIG_SCSI_UFSHCD= module; -CONFIG_SCSI_UFSHCD_PCI= 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-secureboot"; - patch = patchSrc + "/0001-secureboot.patch"; - } - { - name = "ms-surface/0002-surface3"; - patch = patchSrc + "/0002-surface3.patch"; - } - { - name = "ms-surface/0003-mwifiex"; - patch = patchSrc + "/0003-mwifiex.patch"; - } - { - name = "ms-surface/0004-ath10k"; - patch = patchSrc + "/0004-ath10k.patch"; - } - { - name = "ms-surface/0005-ipts"; - patch = patchSrc + "/0005-ipts.patch"; - } - { - name = "ms-surface/0006-ithc"; - patch = patchSrc + "/0006-ithc.patch"; - } - { - name = "ms-surface/0007-surface-sam"; - patch = patchSrc + "/0007-surface-sam.patch"; - } - { - name = "ms-surface/0008-surface-sam-over-hid"; - patch = patchSrc + "/0008-surface-sam-over-hid.patch"; - } - { - name = "ms-surface/0009-surface-button"; - patch = patchSrc + "/0009-surface-button.patch"; - } - { - name = "ms-surface/0010-surface-typecover"; - patch = patchSrc + "/0010-surface-typecover.patch"; - } - { - name = "ms-surface/0011-surface-shutdown"; - patch = patchSrc + "/0011-surface-shutdown.patch"; - } - { - name = "ms-surface/0012-surface-gpe"; - patch = patchSrc + "/0012-surface-gpe.patch"; - } - { - name = "ms-surface/0013-cameras"; - patch = patchSrc + "/0013-cameras.patch"; - } - { - name = "ms-surface/0014-amd-gpio"; - patch = patchSrc + "/0014-amd-gpio.patch"; - } - { - name = "ms-surface/0015-rtc"; - patch = patchSrc + "/0015-rtc.patch"; - } -] diff --git a/microsoft/surface/common/kernel/6.14/patches.nix b/microsoft/surface/common/kernel/6.14/patches.nix new file mode 100644 index 000000000..a78be4060 --- /dev/null +++ b/microsoft/surface/common/kernel/6.14/patches.nix @@ -0,0 +1,158 @@ +{ lib, + kernel ? lib.kernel, + patchSrc, + version, +}: + +[ + { + name = "microsoft-surface-patches-linux-${version}"; + patch = null; + extraStructuredConfig = with kernel; { + STAGING_MEDIA = yes; + ## + ## Surface Aggregator Module + ## + CONFIG_SURFACE_AGGREGATOR = module; + # CONFIG_SURFACE_AGGREGATOR_ERROR_INJECTION is not set + 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; + + CONFIG_SENSORS_SURFACE_TEMP = module; + CONFIG_SENSORS_SURFACE_FAN = module; + + CONFIG_RTC_DRV_SURFACE = module; + + ## + ## Surface Hotplug + ## + CONFIG_SURFACE_HOTPLUG = module; + + ## + ## IPTS and ITHC touchscreen + ## + ## This only enables the user interface for IPTS/ITHC data. + ## For the touchscreen to work, you need to install iptsd. + ## + CONFIG_HID_IPTS = module; + CONFIG_HID_ITHC = module; + + ## + ## Cameras: IPU3 + ## + CONFIG_VIDEO_DW9719 = module; + CONFIG_VIDEO_IPU3_IMGU = module; + CONFIG_VIDEO_IPU3_CIO2 = module; + CONFIG_IPU_BRIDGE = module; + CONFIG_INTEL_SKL_INT3472 = module; + CONFIG_REGULATOR_TPS68470 = module; + CONFIG_COMMON_CLK_TPS68470 = module; + CONFIG_LEDS_TPS68470 = module; + + ## + ## Cameras: Sensor drivers + ## + CONFIG_VIDEO_OV5693 = module; + CONFIG_VIDEO_OV7251 = module; + CONFIG_VIDEO_OV8865 = module; + + ## + ## Surface 3: atomisp causes problems (see issue #1095). Disable it for now. + ## + # CONFIG_INTEL_ATOMISP is not set + + ## + ## ALS Sensor for Surface Book 3, Surface Laptop 3, Surface Pro 7 + ## + CONFIG_APDS9960 = module; + + ## + ## Build-in UFS support (required for some Surface Go devices) + ## + CONFIG_SCSI_UFSHCD = module; + CONFIG_SCSI_UFSHCD_PCI = 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-secureboot"; + patch = patchSrc + "/0001-secureboot.patch"; + } + { + name = "ms-surface/0002-surface3"; + patch = patchSrc + "/0002-surface3.patch"; + } + { + name = "ms-surface/0003-mwifiex"; + patch = patchSrc + "/0003-mwifiex.patch"; + } + { + name = "ms-surface/0004-ath10k"; + patch = patchSrc + "/0004-ath10k.patch"; + } + { + name = "ms-surface/0005-ipts"; + patch = patchSrc + "/0005-ipts.patch"; + } + { + name = "ms-surface/0006-ithc"; + patch = patchSrc + "/0006-ithc.patch"; + } + { + name = "ms-surface/0007-surface-sam"; + patch = patchSrc + "/0007-surface-sam.patch"; + } + { + name = "ms-surface/0008-surface-sam-over-hid"; + patch = patchSrc + "/0008-surface-sam-over-hid.patch"; + } + { + name = "ms-surface/0009-surface-button"; + patch = patchSrc + "/0009-surface-button.patch"; + } + { + name = "ms-surface/0010-surface-typecover"; + patch = patchSrc + "/0010-surface-typecover.patch"; + } + { + name = "ms-surface/0011-surface-shutdown"; + patch = patchSrc + "/0011-surface-shutdown.patch"; + } + { + name = "ms-surface/0012-surface-gpe"; + patch = patchSrc + "/0012-surface-gpe.patch"; + } + { + name = "ms-surface/0013-cameras"; + patch = patchSrc + "/0013-cameras.patch"; + } + { + name = "ms-surface/0014-amd-gpio"; + patch = patchSrc + "/0014-amd-gpio.patch"; + } + { + name = "ms-surface/0015-rtc"; + patch = patchSrc + "/0015-rtc.patch"; + } +] From 34f02c326d7458750b5ac30fae4b794cc0610ab4 Mon Sep 17 00:00:00 2001 From: Andre <10094408+8bitbuddhist@users.noreply.github.com> Date: Wed, 23 Apr 2025 09:49:58 -0400 Subject: [PATCH 8/9] Apply suggestions from code review - option name MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add `hardware` to option name Co-authored-by: Jörg Thalheim --- microsoft/surface/README.md | 2 +- microsoft/surface/common/default.nix | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/microsoft/surface/README.md b/microsoft/surface/README.md index cc5dbde55..7fc5675c0 100644 --- a/microsoft/surface/README.md +++ b/microsoft/surface/README.md @@ -42,7 +42,7 @@ There are multiple versions of the Surface kernel available: This repo uses `longterm` by default, but you can switch it to `stable` by adding this to your configuration file: ```nix -microsoft-surface.kernelVersion = "stable"; +hardware.microsoft-surface.kernelVersion = "stable"; ``` ### Support Tools diff --git a/microsoft/surface/common/default.nix b/microsoft/surface/common/default.nix index 09fa344a6..361b802de 100644 --- a/microsoft/surface/common/default.nix +++ b/microsoft/surface/common/default.nix @@ -4,7 +4,7 @@ let inherit (lib) mkDefault mkOption types versions; # Set the version and hash for the kernel sources - srcVersion = with config.microsoft-surface; + srcVersion = with config.hardware.microsoft-surface; if kernelVersion == "longterm" then "6.12.22" else if kernelVersion == "stable" then @@ -12,7 +12,7 @@ let else abort "Invalid kernel version: ${kernelVersion}"; - srcHash = with config.microsoft-surface; + srcHash = with config.hardware.microsoft-surface; if kernelVersion == "longterm" then "sha256-q0iACrSZhaeNIxiuisXyj9PhI+oXNX7yFJgQWlMzczY=" else if kernelVersion == "stable" then @@ -21,7 +21,7 @@ let abort "Invalid kernel version: ${kernelVersion}"; # Set the version and hash for the linux-surface releases - pkgVersion = with config.microsoft-surface; + pkgVersion = with config.hardware.microsoft-surface; if kernelVersion == "longterm" then "6.12.7" else if kernelVersion == "stable" then @@ -29,7 +29,7 @@ let else abort "Invalid kernel version: ${kernelVersion}"; - pkgHash = with config.microsoft-surface; + pkgHash = with config.hardware.microsoft-surface; if kernelVersion == "longterm" then "sha256-Pv7O8D8ma+MPLhYP3HSGQki+Yczp8b7d63qMb6l4+mY=" else if kernelVersion == "stable" then @@ -60,7 +60,7 @@ let }; in { - options.microsoft-surface.kernelVersion = mkOption { + options.hardware.microsoft-surface.kernelVersion = mkOption { description = "Kernel Version to use (patched for MS Surface)"; type = types.enum [ "longterm" From 306ff6c5f6b5554ef5e99af7cc336518d51538d3 Mon Sep 17 00:00:00 2001 From: Andre Date: Wed, 23 Apr 2025 13:44:36 -0400 Subject: [PATCH 9/9] surface: revert longterm kernel to 6.12.19 --- microsoft/surface/common/default.nix | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/microsoft/surface/common/default.nix b/microsoft/surface/common/default.nix index 361b802de..5d9d7d981 100644 --- a/microsoft/surface/common/default.nix +++ b/microsoft/surface/common/default.nix @@ -6,7 +6,7 @@ let # Set the version and hash for the kernel sources srcVersion = with config.hardware.microsoft-surface; if kernelVersion == "longterm" then - "6.12.22" + "6.12.19" else if kernelVersion == "stable" then "6.14.2" else @@ -14,7 +14,7 @@ let srcHash = with config.hardware.microsoft-surface; if kernelVersion == "longterm" then - "sha256-q0iACrSZhaeNIxiuisXyj9PhI+oXNX7yFJgQWlMzczY=" + "sha256-1zvwV77ARDSxadG2FkGTb30Ml865I6KB8y413U3MZTE=" else if kernelVersion == "stable" then "sha256-xcaCo1TqMZATk1elfTSnnlw3IhrOgjqTjhARa1d6Lhs=" else