Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

twrp: Initial basic support for TWRP builds #99

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

twrp: Initial basic support for TWRP builds #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0294b7f
twrp: Init TWRP integration
samueldr Apr 25, 2021
86d6c9f
twrp: Prepare for multiple branches
samueldr Dec 4, 2021
2b993d3
twrp: Add support for the android-10 based branch
samueldr Dec 4, 2021
f5a4975
[DONTMERGE] surfna example configuration
samueldr Apr 25, 2021
d9f9781
[DONTMERGE] sofiar example configuration
samueldr Dec 4, 2021
7a21c7f
source: Don't dereference links when linking
samueldr Dec 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions default.nix
View file
Open in desktop
Expand Up @@ -34,6 +34,7 @@ let
./flavors/grapheneos
./flavors/grapheneos/kernel.nix
./flavors/lineageos
./flavors/twrp
./flavors/vanilla
./flavors/vanilla/10
./flavors/vanilla/11
Expand Down
87 changes: 87 additions & 0 deletions flavors/twrp/default.nix
View file
Open in desktop
@@ -0,0 +1,87 @@
# SPDX-FileCopyrightText: 2021 Samuel Dionne-Riel
# SPDX-FileCopyrightText: 2021 Daniel Fullmer and robotnix contributors
# SPDX-License-Identifier: MIT

{ config, pkgs, lib, ... }:
let
inherit (lib)
mkDefault
mkIf
mkMerge
;
androidVersionToTWRPBranch = {
"9" = "twrp-9.0";
"10" = "twrp-10.0-deprecated";
};
TWRPBranch = androidVersionToTWRPBranch.${toString config.androidVersion};
repoDirs = lib.importJSON (./. + "/${TWRPBranch}/repo.json");
in mkIf (config.flavor == "twrp")
(mkMerge [
{
# Defaults elsewhere makes it default to `12` if unset.
androidVersion = mkDefault (builtins.throw "androidVersion needs to be set according to your device tree.");

# product names start with "omni_"
# → lunch omni_sailfish-eng
productNamePrefix = "omni_";

buildDateTime = mkDefault 1616627550;

# TWRP uses this by default. If your device supports it, I recommend using variant = "user"
variant = mkDefault "eng";

source.dirs = mkMerge ([
repoDirs
]);

source.manifest.url = mkDefault "https://github.com/minimal-manifest-twrp/platform_manifest_twrp_omni.git";
source.manifest.rev = mkDefault "refs/heads/${TWRPBranch}";
envVars.RELEASE_TYPE = mkDefault "EXPERIMENTAL"; # Other options are RELEASE NIGHTLY SNAPSHOT EXPERIMENTAL

build = {
twrp = config.build.mkAndroid {
name = "robotnix-${config.productName}-${config.buildNumber}";
makeTargets = [ "recoveryimage" ];
samueldr marked this conversation as resolved.
Show resolved Hide resolved
# Note that $ANDROID_PRODUCT_OUT is set by choosecombo above
installPhase = ''
mkdir -p $out
cp --reflink=auto $ANDROID_PRODUCT_OUT/recovery.img $out/
'';
};
Comment on lines +42 to +50
Copy link
Contributor Author

@samueldr samueldr Dec 4, 2021 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How should we handle the need to provide either bootimage or recoveryimage, and $ANDROID_PRODUCT_OUT/recovery.img or $ANDROID_PRODUCT_OUT/boot.img conditionally on something I'm not even sure we can get?

Would adding an option be correct?

};
}
(mkIf (config.androidVersion == 9) {
source.dirs = mkMerge ([
repoDirs
{
"bootable/recovery" = {
patches = [
./patches/android_bootable_recovery/0001-gui-Don-t-preserve-mode-owner-when-copying-files.patch
];
};
"build/make" = {
patches = [
./patches/android_build/0001-Work-around-source-files-being-read-only.patch
];
};
}
]);
})
(mkIf (config.androidVersion == 10) {
# It seems to want a lot of packages normally present in androidVersion == 9...
envPackages = with pkgs; [
openssl.dev
bison
flex
perl
which
];

# Ugh, something really wants `ccache` in these repos.
# :/
ccache.enable = lib.mkForce true;
envVars = {
CCACHE_DIR = lib.mkForce "/tmp"; # Make configurable?
};
})
])
29 changes: 29 additions & 0 deletions ...hes/android_bootable_recovery/0001-gui-Don-t-preserve-mode-owner-when-copying-files.patch
View file
Open in desktop
@@ -0,0 +1,29 @@
From 36960782d92c384db2d74795d458a3cfb5f6013d Mon Sep 17 00:00:00 2001
From: Samuel Dionne-Riel <samuel@dionne-riel.com>
Date: Sat, 24 Apr 2021 18:46:05 -0400
Subject: [PATCH] gui: Don't preserve mode,owner when copying files

When building under some strict build environments, like robotnix, it
fails since the source files are in directories without +w.
---
gui/Android.mk | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/gui/Android.mk b/gui/Android.mk
index 32c0d5b1..4ccdf386 100755
--- a/gui/Android.mk
+++ b/gui/Android.mk
@@ -216,8 +216,8 @@ TWRP_RES += $(TW_ADDITIONAL_RES)
TWRP_RES_GEN := $(intermediates)/twrp
$(TWRP_RES_GEN):
mkdir -p $(TARGET_RECOVERY_ROOT_OUT)$(TWRES_PATH)
- cp -fr $(TWRP_RES) $(TARGET_RECOVERY_ROOT_OUT)$(TWRES_PATH)
- cp -fr $(TWRP_THEME_LOC)/* $(TARGET_RECOVERY_ROOT_OUT)$(TWRES_PATH)
+ cp --no-preserve=owner,mode -fr $(TWRP_RES) $(TARGET_RECOVERY_ROOT_OUT)$(TWRES_PATH)
+ cp --no-preserve=owner,mode -fr $(TWRP_THEME_LOC)/* $(TARGET_RECOVERY_ROOT_OUT)$(TWRES_PATH)

LOCAL_GENERATED_SOURCES := $(TWRP_RES_GEN)
LOCAL_SRC_FILES := twrp $(TWRP_RES_GEN)
--
2.29.2

103 changes: 103 additions & 0 deletions flavors/twrp/patches/android_build/0001-Work-around-source-files-being-read-only.patch
View file
Open in desktop
@@ -0,0 +1,103 @@
From 12382e7d66d993d89e52e840e7965009de2f81e5 Mon Sep 17 00:00:00 2001
From: Samuel Dionne-Riel <samuel@dionne-riel.com>
Date: Sat, 24 Apr 2021 21:05:00 -0400
Subject: [PATCH] Work around source files being read-only

---
core/Makefile | 33 +++++++++++++++++----------------
1 file changed, 17 insertions(+), 16 deletions(-)

diff --git a/core/Makefile b/core/Makefile
index 2f7219daa..43017a35b 100644
--- a/core/Makefile
+++ b/core/Makefile
@@ -84,7 +84,7 @@ gen := $(OUT_DOCS)/index.html
ALL_DOCS += $(gen)
$(gen): frameworks/base/docs/docs-redirect-index.html
@mkdir -p $(dir $@)
- @cp -f $< $@
+ @cp --no-preserve=owner,mode -f $< $@
endif

ndk_doxygen_out := $(OUT_NDK_DOCS)
@@ -1052,7 +1052,7 @@ $(TARGET_OUT_ETC)/update_engine/update-payload-key.pub.pem: $(addsuffix .x509.pe

ALL_DEFAULT_INSTALLED_MODULES += $(TARGET_RECOVERY_ROOT_OUT)/etc/update_engine/update-payload-key.pub.pem
$(TARGET_RECOVERY_ROOT_OUT)/etc/update_engine/update-payload-key.pub.pem: $(TARGET_OUT_ETC)/update_engine/update-payload-key.pub.pem
- $(hide) cp -f $< $@
+ $(hide) cp --no-preserve=owner,mode -f $< $@
endif
endif

@@ -1413,27 +1413,28 @@ define build-recoveryramdisk
# Use rsync because "cp -Rf" fails to overwrite broken symlinks on Mac.
$(hide) rsync -a --exclude=etc --exclude=sdcard --exclude=vendor $(IGNORE_RECOVERY_SEPOLICY) $(IGNORE_CACHE_LINK) $(TARGET_ROOT_OUT) $(TARGET_RECOVERY_OUT)
# Copy adbd from system/bin to recovery/root/sbin
- $(hide) cp -f $(TARGET_OUT_EXECUTABLES)/adbd $(TARGET_RECOVERY_ROOT_OUT)/sbin/adbd
+ $(hide) cp --no-preserve=owner,mode -f $(TARGET_OUT_EXECUTABLES)/adbd $(TARGET_RECOVERY_ROOT_OUT)/sbin/adbd
# Modifying ramdisk contents...
$(if $(BOARD_RECOVERY_KERNEL_MODULES), \
$(call build-image-kernel-modules,$(BOARD_RECOVERY_KERNEL_MODULES),$(TARGET_RECOVERY_ROOT_OUT),,$(call intermediates-dir-for,PACKAGING,depmod_recovery)))
# Removes $(TARGET_RECOVERY_ROOT_OUT)/init*.rc EXCEPT init.recovery*.rc.
$(hide) find $(TARGET_RECOVERY_ROOT_OUT) -maxdepth 1 -name 'init*.rc' -type f -not -name "init.recovery.*.rc" | xargs rm -f
- $(hide) cp -f $(recovery_initrc) $(TARGET_RECOVERY_ROOT_OUT)/
- $(hide) cp $(TARGET_ROOT_OUT)/init.recovery.*.rc $(TARGET_RECOVERY_ROOT_OUT)/ || true # Ignore error when the src file doesn't exist.
+ $(hide) cp --no-preserve=owner,mode -f $(recovery_initrc) $(TARGET_RECOVERY_ROOT_OUT)/
+ chmod -R +w $(TARGET_RECOVERY_ROOT_OUT)
+ $(hide) cp --no-preserve=owner,mode $(TARGET_ROOT_OUT)/init.recovery.*.rc $(TARGET_RECOVERY_ROOT_OUT)/ || true # Ignore error when the src file doesn't exist.
$(hide) mkdir -p $(TARGET_RECOVERY_ROOT_OUT)/res
$(hide) rm -rf $(TARGET_RECOVERY_ROOT_OUT)/res/*
- $(hide) cp -rf $(recovery_resources_common)/* $(TARGET_RECOVERY_ROOT_OUT)/res
- $(hide) cp -f $(recovery_font) $(TARGET_RECOVERY_ROOT_OUT)/res/images/font.png
+ $(hide) cp --no-preserve=owner,mode -rf $(recovery_resources_common)/* $(TARGET_RECOVERY_ROOT_OUT)/res
+ $(hide) cp --no-preserve=owner,mode -f $(recovery_font) $(TARGET_RECOVERY_ROOT_OUT)/res/images/font.png
$(hide) $(foreach item,$(recovery_root_private), \
- cp -rf $(item) $(TARGET_RECOVERY_OUT)/;)
+ cp --no-preserve=owner,mode -rf $(item) $(TARGET_RECOVERY_OUT)/;)
$(hide) $(foreach item,$(TARGET_PRIVATE_RES_DIRS), \
- cp -rf $(item) $(TARGET_RECOVERY_ROOT_OUT)/$(newline))
+ cp --no-preserve=owner,mode -rf $(item) $(TARGET_RECOVERY_ROOT_OUT)/$(newline))
$(hide) $(foreach item,$(recovery_fstab), \
- cp -f $(item) $(TARGET_RECOVERY_ROOT_OUT)/etc/recovery.fstab)
+ cp --no-preserve=owner,mode -f $(item) $(TARGET_RECOVERY_ROOT_OUT)/etc/recovery.fstab)
$(if $(strip $(recovery_wipe)), \
- $(hide) cp -f $(recovery_wipe) $(TARGET_RECOVERY_ROOT_OUT)/etc/recovery.wipe)
- $(hide) cp $(RECOVERY_INSTALL_OTA_KEYS) $(TARGET_RECOVERY_ROOT_OUT)/res/keys
+ $(hide) cp --no-preserve=mode -f $(recovery_wipe) $(TARGET_RECOVERY_ROOT_OUT)/etc/recovery.wipe)
+ $(hide) cp --no-preserve=owner,mode $(RECOVERY_INSTALL_OTA_KEYS) $(TARGET_RECOVERY_ROOT_OUT)/res/keys
$(hide) cat $(INSTALLED_DEFAULT_PROP_TARGET) \
> $(TARGET_RECOVERY_ROOT_OUT)/prop.default
$(if $(INSTALLED_VENDOR_DEFAULT_PROP_TARGET), \
@@ -1514,7 +1515,7 @@ $(recovery_uncompressed_ramdisk): $(MKBOOTFS) $(ADBD) \
$(BOARD_RECOVERY_KERNEL_MODULES) \
$(DEPMOD)
$(call build-recoveryramdisk)
- @echo ----- Making uncompressed recovery ramdisk ------
+ @echo ----- Making uncompressed recovery ramdisk YAY ------
$(hide) $(MKBOOTFS) $(TARGET_RECOVERY_ROOT_OUT) > $@

$(recovery_ramdisk): $(MINIGZIP) \
@@ -1857,7 +1858,7 @@ endif
define build-boottarball-target
$(hide) echo "Target boot fs tarball: $(INSTALLED_BOOTTARBALL_TARGET)"
$(hide) mkdir -p $(PRODUCT_OUT)/boot
- $(hide) cp -f $(INTERNAL_BOOTIMAGE_FILES) $(PRODUCT_OUT)/boot/.
+ $(hide) cp --no-preserve=owner,mode -f $(INTERNAL_BOOTIMAGE_FILES) $(PRODUCT_OUT)/boot/.
$(hide) echo $(INTERNAL_KERNEL_CMDLINE) > $(PRODUCT_OUT)/boot/cmdline
$(hide) $(MKTARBALL) $(FS_GET_STATS) \
$(PRODUCT_OUT) boot $(PRIVATE_BOOT_TAR) \
@@ -3398,9 +3399,9 @@ $(INTERNAL_SDK_TARGET): $(deps)
-v "DLL_EXTENSION=$(HOST_SHLIB_SUFFIX)" \
-v "FONT_OUT=$(SDK_FONT_TEMP)" \
-o $(PRIVATE_DIR) && \
- cp -f $(target_notice_file_txt) \
+ cp --no-preserve=owner,mode -f $(target_notice_file_txt) \
$(PRIVATE_DIR)/system-images/android-$(PLATFORM_VERSION)/$(TARGET_CPU_ABI)/NOTICE.txt && \
- cp -f $(tools_notice_file_txt) $(PRIVATE_DIR)/platform-tools/NOTICE.txt && \
+ cp --no-preserve=owner,mode -f $(tools_notice_file_txt) $(PRIVATE_DIR)/platform-tools/NOTICE.txt && \
HOST_OUT_EXECUTABLES=$(HOST_OUT_EXECUTABLES) HOST_OS=$(HOST_OS) \
development/build/tools/sdk_clean.sh $(PRIVATE_DIR) && \
chmod -R ug+rwX $(PRIVATE_DIR) && \
--
2.29.2