Merge pull request #39 from numtide/hardware-config

move all hardware detection to its own namespace

Author: Mic92

docs.nix

@@ -65,25 +65,9 @@ pkgs.mkShellNoCC {
           cat ${optionsDoc.optionsCommonMark} > $out/${snakeCase name}.md
         '';
 
-      # Allows us to gather all options that are immediate children of `facter` and which have no child options.
-      # e.g. facter.reportPath, facter.report.
-      # For all other options we group them by the first immediate child of `facter`.
-      # e.g. facter.bluetooth, facter.boot and so on.
-      # This allows us to have a page for root facter options "facter.md", and a page each for the major sub modules.
-      facterOptionsFilter =
-        _:
-        {
-          loc ? [ ],
-          options ? [ ],
-          ...
-        }:
-        (lib.length loc) == 2 && ((lib.elemAt loc 0) == "facter") && (lib.length options) == 0;
-
-      otherOptionsFilter = n: v: !(facterOptionsFilter n v);
-
-      facterMarkdown = mkMarkdown "facter" (lib.filterAttrs facterOptionsFilter eval.options.facter);
+      facterMarkdown = mkMarkdown "facter" eval.options.facter.detected;
       otherMarkdown = lib.mapAttrsToList mkMarkdown (
-        lib.filterAttrs otherOptionsFilter eval.options.facter
+        lib.filterAttrs (n: v: n != "detected") eval.options.facter
       );
 
       optionsMarkdown = pkgs.symlinkJoin {
@@ -92,7 +76,6 @@ pkgs.mkShellNoCC {
       };
 
     in
-    with pkgs;
     [
       (pkgs.writeScriptBin "mkdocs" ''
         # rsync in NixOS modules doc to avoid issues with symlinks being owned by root

modules/nixos/bluetooth.nix

@@ -1,8 +1,8 @@
 { lib, config, ... }:
 {
-  options.facter.bluetooth.enable = lib.mkEnableOption "Enable the Facter bluetooth module" // {
+  options.facter.detected.bluetooth.enable = lib.mkEnableOption "Enable the Facter bluetooth module" // {
     default = builtins.length (config.facter.report.hardware.bluetooth or []) > 0;
   };
 
-  config.hardware.bluetooth.enable = lib.mkIf config.facter.bluetooth.enable (lib.mkDefault true);
+  config.hardware.bluetooth.enable = lib.mkIf config.facter.detected.bluetooth.enable (lib.mkDefault true);
 }

modules/nixos/boot.nix

@@ -0,0 +1,27 @@
+{ lib, config, ... }:
+let
+  facterLib = import ../../lib/lib.nix lib;
+
+  inherit (config.facter) report;
+in
+{
+  options.facter.detected.boot.disk.kernelModules = lib.mkOption {
+    type = lib.types.listOf lib.types.str;
+    default = facterLib.stringSet (
+        facterLib.collectDrivers (
+          # A disk might be attached.
+          (report.hardware.firewire_controller or [ ])
+          # definitely important
+          ++ (report.hardware.disk or [ ])
+          ++ (report.hardware.storage_controller or [ ])
+        )
+      );
+    description = ''
+      List of kernel modules that are needed to access the disk.
+    '';
+  };
+
+  config = {
+    boot.initrd.availableKernelModules = config.facter.detected.boot.disk.kernelModules;
+  };
+}

modules/nixos/disk.nix

@@ -11,7 +11,8 @@ in
 {
   imports = [
     ./bluetooth.nix
-    ./boot.nix
+    ./disk.nix
+    ./keyboard.nix
     ./firmware.nix
     ./graphics.nix
     ./networking

modules/nixos/facter.nix

@@ -3,7 +3,7 @@ let
   facterLib = import ../../lib/lib.nix lib;
 
   inherit (config.facter) report;
-  isBaremetal = config.facter.virtualisation.none.enable;
+  isBaremetal = config.facter.detected.virtualisation.none.enable;
   hasAmdCpu = facterLib.hasAmdCpu report;
   hasIntelCpu = facterLib.hasIntelCpu report;
 in

modules/nixos/firmware.nix

@@ -1,16 +1,28 @@
 { lib, config, ... }:
 let
   facterLib = import ../../lib/lib.nix lib;
+  cfg = config.facter.detected.graphics;
 in
 {
-  options.facter.graphics.enable = lib.mkEnableOption "Enable the Graphics module" // {
-    default = builtins.length (config.facter.report.hardware.monitor or [ ]) > 0;
+  options.facter.detected = {
+    graphics.enable = lib.mkEnableOption "Enable the Graphics module" // {
+      default = builtins.length (config.facter.report.hardware.monitor or [ ]) > 0;
+    };
+    boot.graphics.kernelModules = lib.mkOption {
+      type = lib.types.listOf lib.types.str;
+      # We currently don't auto import nouveau, in case the user might want to use the proprietary nvidia driver,
+      # We might want to change this in future, if we have a better idea, how to handle this.
+      default = lib.remove "nouveau" (
+        facterLib.stringSet (facterLib.collectDrivers (config.facter.report.hardware.graphics_card or [ ]))
+      );
+      description = ''
+        List of kernel modules to load at boot for the graphics card.
+      '';
+    };
   };
 
-  config = lib.mkIf config.facter.graphics.enable {
+  config = lib.mkIf cfg.enable {
     hardware.graphics.enable = lib.mkDefault true;
-    boot.initrd.kernelModules = facterLib.stringSet (
-      facterLib.collectDrivers (config.facter.report.hardware.graphics_card or [ ])
-    );
+    boot.initrd.kernelModules = config.facter.detected.boot.graphics.kernelModules;
   };
 }

modules/nixos/graphics.nix

@@ -0,0 +1,20 @@
+{ lib, config, ... }:
+let
+  facterLib = import ../../lib/lib.nix lib;
+
+  inherit (config.facter) report;
+in
+{
+  options.facter.detected.boot.keyboard.kernelModules = lib.mkOption {
+    type = lib.types.listOf lib.types.str;
+    default = facterLib.collectDrivers (report.hardware.usb_controller or [ ]);
+    example = [ "usbhid" ];
+    description = ''
+      List of kernel modules to include in the initrd to support the keyboard.
+    '';
+  };
+
+  config = {
+    boot.initrd.availableKernelModules = config.facter.detected.boot.keyboard.kernelModules;
+  };
+}

modules/nixos/keyboard.nix

@@ -1,10 +1,10 @@
 { lib, config, ... }:
 let
   inherit (config.facter) report;
-  cfg = config.facter.networking.broadcom;
+  cfg = config.facter.detected.networking.broadcom;
 in
 {
-  options.facter.networking.broadcom = with lib; {
+  options.facter.detected.networking.broadcom = with lib; {
     full_mac.enable = mkEnableOption "Enable the Facter Broadcom Full MAC module" // {
 
       default = lib.any (

modules/nixos/networking/broadcom.nix

@@ -1,10 +1,10 @@
 { lib, config, ... }:
 let
   inherit (config.facter) report;
-  cfg = config.facter.networking.intel;
+  cfg = config.facter.detected.networking.intel;
 in
 {
-  options.facter.networking.intel = with lib; {
+  options.facter.detected.networking.intel = with lib; {
     _2200BG.enable = mkEnableOption "Enable the Facter Intel 2200BG module" // {
 
       default = lib.any (

modules/nixos/networking/intel.nix

@@ -6,10 +6,10 @@
 }:
 let
   inherit (config.facter) report;
-  cfg = config.facter.virtualisation;
+  cfg = config.facter.detected.virtualisation;
 in
 {
-  options.facter.virtualisation = {
+  options.facter.detected.virtualisation = {
     virtio_scsi.enable = lib.mkEnableOption "Enable the Facter Virtualisation Virtio SCSI module" // {
       default = lib.any (
         { vendor, device, ... }: