Subject: [bug#48371] Add crust firmware for sunxi devices

From: Vagrant Cascadian <[email-masked]>
Date: Tue, 11 May 2021 15:15:31 -0700

The attached patches add crust System Control Processor firmware for
pinebook, pine64+ and pine64-lts. Crust manages various power management
aspects for these platforms, notably suspend states.

live well,
  vagrant
From f79a6bec79bd00ab3ecb0f874494df597bfa1990 Mon Sep 17 00:00:00 2001
From: Vagrant Cascadian <[email-masked]>
Date: Tue, 11 May 2021 20:57:50 +0000
Subject: [PATCH 1/2] gnu: Add crust-pinebook and crust-pine64-plus.

* gnu/packages/bootstrap.scm (glibc-dynamic-linker): Add or1k-elf.
  gnu/packages/firmware.scm (make-crust-package, crust-pinebook,
  crust-pine64-plus): New variables.
---
 gnu/packages/bootstrap.scm |  1 +
 gnu/packages/firmware.scm  | 71 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 72 insertions(+)

diff --git a/gnu/packages/bootstrap.scm b/gnu/packages/bootstrap.scm
index c598cedc0a..b23ac04586 100644
--- a/gnu/packages/bootstrap.scm
+++ b/gnu/packages/bootstrap.scm
@@ -315,6 +315,7 @@ or false to signal an error."
         ((string=? system "i686-mingw") "no-ld.so")
         ((string=? system "x86_64-mingw") "no-ld.so")
         ((string=? system "vc4-elf") "no-ld.so")
+        ((string=? system "or1k-elf") "no-ld.so")
 
         (else (error "dynamic linker name not known for this system"
                      system))))
diff --git a/gnu/packages/firmware.scm b/gnu/packages/firmware.scm
index c9a68f5a93..a057cbe516 100644
--- a/gnu/packages/firmware.scm
+++ b/gnu/packages/firmware.scm
@@ -559,3 +559,74 @@ such as:
        `(("cross32-gcc" ,(cross-gcc "arm-none-eabi"))
          ("cross32-binutils", (cross-binutils "arm-none-eabi"))
          ,@(package-native-inputs base))))))
+
+(define (make-crust-package platform)
+  (package
+    (name (string-append "crust-"
+                         (string-replace-substring (string-downcase platform)
+                                                   "_" "-")))
+    (version "0.3")
+    (source
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+             ;; There are only GitHub generated release snapshots.
+             (url "https://github.com/crust-firmware/crust")
+             (commit (string-append "v" version))))
+       (file-name (git-file-name "crust" version))
+       (sha256
+        (base32
+         "1ncn2ncmkj1cjk68zrgr5yk7b9x1xxcrcmk9jf188svjgk0cq2m5"))))
+    (build-system gnu-build-system)
+    (arguments
+     `(#:phases
+       (modify-phases %standard-phases
+         (delete 'configure)
+         (add-before 'build 'defconfig
+           (lambda* (#:key outputs make-flags #:allow-other-keys)
+             (let ((config-name (string-append ,platform "_defconfig")))
+               (apply invoke "make" `(,@make-flags ,config-name)))))
+         (replace 'install
+           (lambda* (#:key outputs #:allow-other-keys)
+             (let ((out (assoc-ref outputs "out"))
+                   (bin (find-files "." "(scp.bin|\\.config)")))
+               (for-each
+                (lambda (file)
+                  (install-file file out))
+                bin))
+             #t)))
+       #:make-flags (list
+                     "CROSS_COMPILE=or1k-elf-"
+                     "DEBUG=1"
+                     "HOSTCC=gcc"
+                     "HOSTAR=ar"
+                     "HOST_COMPILE=aarch64-linux-gnu-"
+                     "LEX=flex")
+       #:tests? #f)) ; no tests
+    ;; The firmware is cross-compiled using a "bare bones" compiler (no libc.)
+    ;; Use our own tool chain for that.
+    (native-inputs `(("cross-gcc" ,(cross-gcc "or1k-elf" #:xgcc gcc-9))
+                     ("cross-binutils" ,(cross-binutils "or1k-elf" binutils))
+                     ("bison" ,bison)
+                     ("flex" ,flex)))
+    (home-page "https://github.com/crust-firmware/crust")
+    (synopsis "System control processor firmware for Allwinner sunxi boards")
+    (description
+     "Crust improves battery life and thermal performance by implementing a
+deep sleep state.  During deep sleep, the CPU cores, the DRAM controller, and
+most onboard peripherals are powered down, reducing power consumption by 80%
+or more compared to an idle device.  On boards without a PMIC, Crust is also
+responsible for orderly power-off and power-on of the device.
+
+For this to work, Crust runs outside the main CPU and DRAM, on a dedicated
+always-on microprocessor called a System Control Processor (SCP).  Crust is
+designed to run on a specific SCP implementation, Allwinner's AR100.")
+    ;; Most files are dual-licensed "BSD-3 OR GPL2", a few are GPL2 only.
+    (license (list license:bsd-3
+                   license:gpl2))))
+
+(define-public crust-pinebook
+  (make-crust-package "pinebook"))
+
+(define-public crust-pine64-plus
+  (make-crust-package "pine64_plus"))
-- 
2.30.2

From 6939b8555f4d2ed57b4993c501686d5ccdf47703 Mon Sep 17 00:00:00 2001
From: Vagrant Cascadian <[email-masked]>
Date: Tue, 11 May 2021 21:15:15 +0000
Subject: [PATCH 2/2] gnu: u-boot: Add crust firmware to pinebook, pine64_plus
 and pine64-lts.

* gnu/packages/bootloaders.scm (make-u-boot-sunxi64-package): Take argument
  for System Control Processor (SCP) firmware.
  [native-inputs]: Add SCP firmware.
  (u-boot-pine64-plus, u-boot-pine64-lts, u-boot-pinebook): Pass appropriate
  crust firmware as the SCP firmware.
---
 gnu/packages/bootloaders.scm | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/gnu/packages/bootloaders.scm b/gnu/packages/bootloaders.scm
index 56bef57cb7..6f1bb5b8c9 100644
--- a/gnu/packages/bootloaders.scm
+++ b/gnu/packages/bootloaders.scm
@@ -737,7 +737,7 @@ it fits within common partitioning schemes.")
 (define-public u-boot-am335x-evm
   (make-u-boot-package "am335x_evm" "arm-linux-gnueabihf"))
 
-(define-public (make-u-boot-sunxi64-package board triplet)
+(define-public (make-u-boot-sunxi64-package board triplet scpfirmware)
   (let ((base (make-u-boot-package board triplet)))
     (package
       (inherit base)
@@ -752,6 +752,9 @@ it fits within common partitioning schemes.")
                           (assoc-ref (or native-inputs inputs) "firmware")
                           "/bl31.bin")))
                     (setenv "BL31" bl31)
+                    (setenv "SCP" (string-append
+                                   (assoc-ref inputs "scpfirmware")
+                                   "/scp.bin"))
                     ;; This is necessary when we're using the bundled dtc.
                     ;(setenv "PATH" (string-append (getenv "PATH") ":"
                     ;                              "scripts/dtc"))
@@ -759,16 +762,20 @@ it fits within common partitioning schemes.")
                   #t))))))
       (native-inputs
        `(("firmware" ,arm-trusted-firmware-sun50i-a64)
+         ("scpfirmware" ,scpfirmware)
          ,@(package-native-inputs base))))))
 
 (define-public u-boot-pine64-plus
-  (make-u-boot-sunxi64-package "pine64_plus" "aarch64-linux-gnu"))
+  (make-u-boot-sunxi64-package "pine64_plus" "aarch64-linux-gnu"
+                               crust-pine64-plus))
 
 (define-public u-boot-pine64-lts
-  (make-u-boot-sunxi64-package "pine64-lts" "aarch64-linux-gnu"))
+  (make-u-boot-sunxi64-package "pine64-lts" "aarch64-linux-gnu"
+                               crust-pine64-plus))
 
 (define-public u-boot-pinebook
-  (let ((base (make-u-boot-sunxi64-package "pinebook" "aarch64-linux-gnu")))
+  (let ((base (make-u-boot-sunxi64-package "pinebook" "aarch64-linux-gnu"
+                                           crust-pinebook)))
     (package
       (inherit base)
       (arguments
-- 
2.30.2