hardware/amlogic: Add default installation steps

oSoWoSo · Feb 26, 2022 · dfefba7 · dfefba7
1 parent c299e5a
commit dfefba7
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/modules/hardware/amlogic/default.nix b/modules/hardware/amlogic/default.nix
@@ -29,6 +29,9 @@ let
     amlogicG12
     amlogicGXL
   ];
+
+  anyAmlogic = lib.any (v: v) [amlogicGXL amlogicG12];
+  isPhoneUX = config.Tow-Boot.phone-ux.enable;
 in
 {
   options = {
@@ -203,5 +206,23 @@ in
         };
       };
     })
+
+    # Documentation fragments
+    (mkIf (anyAmlogic && !isPhoneUX) {
+      documentation.sections.installationInstructions =
+        lib.mkDefault
+        (config.documentation.helpers.genericInstallationInstructionsTemplate {
+          startupConflictNote = ''
+
+            > **NOTE**: The SoC startup order for Amlogic systems will
+            > prefer *SPI*, then *eMMC*, followed by *SD* last.
+            >
+            > You may need to prevent default startup sources from being used
+            > to install using the Tow-Boot installer image.
+
+          '';
+        })
+      ;
+    })
   ];
 }