mirror of https://github.com/NixOS/nixos-hardware synced 2025-01-12 11:59:46 +01:00

History

xenia 4c0d42b582 framework: refactor kmod for improved AMD support Changes several aspects of framework-laptop-kmod support: - default value has been changed to true when NixOS >= 24.05 and linux kernel >=6.10, and false otherwise - adds required patch for framework AMD enablement when kernel <6.10 - add README section describing usage		2024-12-01 23:04:16 -05:00
..
13-inch	framework: Add `hardware.framework.laptop13.audioEnhancement` option	2024-11-16 22:44:58 +00:00
16-inch	framework: workaround display issues on AMD GPUs	2024-11-12 09:27:24 +00:00
bluetooth.nix	framework/bluetooth.nix: add EOL remark	2024-11-02 03:52:24 +00:00
default.nix	Fixed broken links in deprecation assertions for framework and surface modules.	2023-11-14 21:35:07 +00:00
framework-tool.nix	framework: install framework-tool	2024-05-06 08:28:51 +00:00
kmod.nix	framework: refactor kmod for improved AMD support	2024-12-01 23:04:16 -05:00
OLD-BEHAVIOUR-DEPRECATION.md	Explicitly speak of 11th gen Intel Framework new profile	2023-11-11 16:32:26 -05:00
README.md	framework: refactor kmod for improved AMD support	2024-12-01 23:04:16 -05:00

README.md

NOTE: Structure changes from 2023-11-11

Please read the Deprecated Behaviour README to understand how some structural changes to the code might affect you!

Framework Laptops

Updating Firmware

First put enable fwupd

services.fwupd.enable = true;

Note

For Intel CPU's, even stable BIOS versions are currently marked as test versions in LVFS (the default remote fwupd uses to get firmware).

If you want to use these versions, you'll have to explicitly enable the lvfs-testing remote:
services.fwupd.extraRemotes = [ "lvfs-testing" ];
# Might be necessary once to make the update succeed
services.fwupd.uefiCapsuleSettings.DisableCapsuleUpdateOnDisk = true;

Caution

Before running the update, make sure you have a NixOS live ISO on a USB stick, because some firmware updates make your system unbootable.

Then run

 $ fwupdmgr update

If you cannot boot into your system after upgrading:

Boot into the live USB
Mount your system into /mnt
Run
```
sudo nixos-enter
```

Run

NIXOS_INSTALL_BOOTLOADER=1 /run/current-system/bin/switch-to-configuration boot

Common Modules

For the Framework 13 laptops, there are common configuration modules available under the 13-inch/common/ directory, including some modules specific to AMD- or Intel-based laptops. By preference, there will already be a specialised module for your model's configuration. Otherwise, it can be added alongside the existing modules.

OS integration

hardware.framework.enableKmod enables the community-created Framework kernel module which exposes EC functionality like battery charge limit, privacy switches, and system LEDs as standard driver interfaces. This enables, for example, configuring the charge limit using the KDE settings GUI. The option is enabled by default when NixOS >= 24.05 and linux kernel version >= 6.10.

On AMD Framework 13 and 16, before kernel 6.10, additional kernel patches are required for the kernel module to function properly. Manually setting hardware.framework.enableKmod = true will apply the patches, requiring a kernel recompilation.

Support Tools

fw-ectool

There is a fw-ectool package available in nixpkgs that provides some system configuration options via the EC. This ectool only works with the Intel-based Framework laptops at present, as the Framework EC for AMD-based mainboards is based on the Zephyr port of the ChromeOS EC, which involves a slightly changed communication interface.