bootstd: Add Android support
v3 cover bootstd: Add Android support
Android boot flow is a bit different than a regular Linux distro. Android relies on multiple partitions in order to boot.
A typical boot flow would be:
1. Parse the Bootloader Control Block (BCB, misc partition)
2. If BCB requested bootonce-bootloader, start fastboot and wait.
3. If BCB requested recovery or normal android, run the following:
a. Get slot (A/B) from BCB
b. Run AVB (Android Verified Boot) on boot partitions c. Load boot and vendor_boot partitions
d. Load device-tree, ramdisk and boot
The AOSP documentation has more details at [1], [2], [3]
This has been implemented via complex boot scripts such as [4]. However, these boot script are neither very maintainable nor generic. Moreover, DISTRO_DEFAULTS is being deprecated [5].
Add a generic Android bootflow implementation for bootstd.
For this initial version, only boot image v4 is supported.
This has been tested on sandbox using:
$ ./test/py/test.py --bd sandbox --build -k test_ut
This has also been tested on the AM62X SK EVM using TI's Android SDK[6] To test on TI board, the following (WIP) patch is needed as well:
https://gitlab.baylibre.com/baylibre/ti/ti-u-boot/-/commit/84cceb912bccd7cdd7f9dd69bca0e5d987a1fd04
[1] https://source.android.com/docs/core/architecture/bootloader
[2] https://source.android.com/docs/core/architecture/partitions
[3] https://source.android.com/docs/core/architecture/partitions/generic-boot
[4] https://source.denx.de/u-boot/u-boot/-/blob/master/include/configs/meson64_android.h
[5] https://lore.kernel.org/r/all/[email protected]/
[6] https://software-dl.ti.com/processor-sdk-android/esd/AM62X/09_02_00/docs/android/Overview.html
---
Changes in v3:
- Fixed CI issues (Tom):
* Generate bootv4.img and vendor_boot.img in test_ut.py
* Mark CONFIG_BOOTMETH_ANDROID dependent on CONFIG_CMDLINE
* Make bootflow_android() test dependent on CONFIG_BOOTMETH_ANDROID
Because of the above changes, I've removed the reviewers on patch 5/5
- Link to v2: https://lore.kernel.org/r/[email protected]
Changes in v2:
- Dropped patch 2/6 boot: android: Add image_android_get_version() (Igor)
- Fixed multi-line comment style (Igor, Simon)
- Added dependency on CMD_FASTBOOT for BOOTMETH_ANDROID (Igor)
- Fixed various resource leaks (Igor)
- Fixed bootmeth_priv dangling pointer on error cases (Igor)
- Updated test instructions in commit message for patch 6/6
- Added __weak impl of get_avendor_bootimg_addr() in patch 1 (dropped
Igor's review because of this change)
- Added extra info in Kconfig to detail MMC limitation (Simon)
- Fixed typo Bootmethod->Bootmeth (Simon)
- Documented android_priv structure (Simon)
- Demoted various messages from printf() to log_debug (Simon)
- Fixed some lines too long (Simon)
- Added function documentation to read_slotted_partition() (Simon)
- Added some doc about avb extra_args being modified (Simon)
- Link to v1: https://lore.kernel.org/r/[email protected]
---
Mattijs Korpershoek (5):
boot: android: Provide vendor_bootimg_addr in boot_get_fdt()
bootstd: Add bootflow_iter_check_mmc() helper
android: boot: Add set_abootimg_addr() and set_avendor_bootimg_addr()
bootstd: Add a bootmeth for Android
bootstd: Add test for bootmeth_android
MAINTAINERS | 7 + arch/sandbox/dts/test.dts | 8 + boot/Kconfig | 17 ++ boot/Makefile | 2 + boot/bootflow.c | 12 + boot/bootmeth_android.c | 553 ++++++++++++++++++++++++++++++++++++++++++++++ boot/bootmeth_android.h | 29 +++ boot/image-android.c | 5 + boot/image-fdt.c | 2 +- cmd/abootimg.c | 10 + configs/sandbox_defconfig | 2 +- doc/develop/bootstd.rst | 6 + include/bootflow.h | 9 + include/image.h | 14 ++ test/boot/bootflow.c | 68 +++++- test/py/tests/test_ut.py | 79 +++++++ 16 files changed, 818 insertions(+), 5 deletions(-)
---
base-commit: 475aa8345a78396d39b42f96eccecd37ebe24e99
change-id: 20240605-bootmeth-android-bfc8596e9367
Best regards,
Signature · 1 line
Mattijs Korpershoek <[email protected]>
PATCH v3 1/5 boot: android: Provide vendor_bootimg_addr in boot_get_fdt()
When calling android_image_get_dtb_by_index() using boot image v3+, we should also pass the vendor_boot ramdisk address.
Use get_avendor_bootimg_addr() to do so.
Notes: on boot image v2, this is harmless since get_avendor_bootimg_addr()
returns -1.
for legacy implementations that don't have CMD_ABOOTIMG, add a weak implementation to avoid linking errors.
--- boot/image-android.c | 5 +++++ boot/image-fdt.c | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-)
boot/image-android.c +5 -0
@@ -56,6 +56,11 @@ static ulong add_trailer(ulong bootconfig_start_addr, ulong bootconfig_size)return BOOTCONFIG_TRAILER_SIZE ; } +__weak ulong get_avendor_bootimg_addr (void ) +{ +return -1 ; +} +static void android_boot_image_v3_v4_parse_hdr (const struct andr_boot_img_hdr_v3 *hdr,struct andr_image_data *data) {
boot/image-fdt.c +1 -1
@@ -502,7 +502,7 @@ int boot_get_fdt(void *buf, const char *select, uint arch,* Firstly check if this android boot image has dtb field. */ dtb_idx = (u32 )env_get_ulong ("adtb_idx" ,10 ,0 ); -if (android_image_get_dtb_by_index ((ulong )hdr,0 , +if (android_image_get_dtb_by_index ((ulong )hdr,get_avendor_bootimg_addr (), dtb_idx, &fdt_addr, &fdt_size)) { fdt_blob = (char *)map_sysmem (fdt_addr,0 );if (fdt_check_header (fdt_blob))
Signature · 1 line
2.45.2
PATCH v3 2/5 bootstd: Add bootflow_iter_check_mmc() helper
In reply to Mattijs KorpershoekSome bootflows might be able to only boot from MMC devices.
Add a helper function these bootflows can use.
--- boot/bootflow.c | 12 ++++++++++++ include/bootflow.h | 9 +++++++++ 2 files changed, 21 insertions(+)
boot/bootflow.c +12 -0
@@ -575,6 +575,18 @@ int bootflow_iter_check_blk(const struct bootflow_iter *iter)return -ENOTSUPP ; } +int bootflow_iter_check_mmc (const struct bootflow_iter *iter) +{ +const struct udevice *media =dev_get_parent (iter->dev); +enum uclass_id id =device_get_uclass_id (media); + +log_debug ("uclass %d: %s\n" , id,uclass_get_name (id)); +if (id ==UCLASS_MMC ) +return 0 ; + +return -ENOTSUPP ; +} +int bootflow_iter_check_sf (const struct bootflow_iter *iter) {const struct udevice *media =dev_get_parent (iter->dev);
include/bootflow.h +9 -0
@@ -408,6 +408,15 @@ void bootflow_remove(struct bootflow *bflow);*/ int bootflow_iter_check_blk (const struct bootflow_iter *iter); +/** +* bootflow_iter_check_mmc() - Check that a bootflow uses a MMC device +* +* This checks the bootdev in the bootflow to make sure it uses a mmc device +* +* Return: 0 if OK, -ENOTSUPP if some other device is used (e.g. ethernet) +*/ +int bootflow_iter_check_mmc (const struct bootflow_iter *iter); +/** * bootflow_iter_check_sf() - Check that a bootflow uses SPI FLASH *
Signature · 1 line
2.45.2
Re: [PATCH v3 2/5] bootstd: Add bootflow_iter_check_mmc() helper
Quoted 10 lines · Mattijs Korpershoek
Some bootflows might be able to only boot from MMC devices.
Add a helper function these bootflows can use.
Reviewed-by Igor Opaniuk <[email protected]>Reviewed-by Julien Masson <[email protected]>Reviewed-by Guillaume La Roque <[email protected]>Tested-by Guillaume La Roque <[email protected]>Signed-off-by Mattijs Korpershoek <[email protected]>
Quoted 5 lines
--- boot/bootflow.c | 12 ++++++++++++ include/bootflow.h | 9 +++++++++ 2 files changed, 21 insertions(+)
PATCH v3 3/5 android: boot: Add set_abootimg_addr() and set_avendor_bootimg_addr()
In reply to Mattijs KorpershoekThe only way to configure the load addresses for both bootimg and vendor_bootimg is by using the "abootimg" command.
If we want to use the C API, there is no equivalent.
Add set_abootimg_addr() and set_avendor_bootimg_addr() so that we can specify the load address from C.
This can be useful for implementing an Android bootmethod.
--- cmd/abootimg.c | 10 ++++++++++ include/image.h | 14 ++++++++++++++ 2 files changed, 24 insertions(+)
cmd/abootimg.c +10 -0
@@ -22,6 +22,11 @@ ulong get_abootimg_addr(void)return (_abootimg_addr ==-1 ? image_load_addr : _abootimg_addr); } +void set_abootimg_addr (ulong addr) +{ + _abootimg_addr = addr; +} +ulong get_ainit_bootimg_addr (void ) {return _ainit_bootimg_addr;
@@ -32,6 +37,11 @@ ulong get_avendor_bootimg_addr(void)return _avendor_bootimg_addr; } +void set_avendor_bootimg_addr (ulong addr) +{ + _avendor_bootimg_addr = addr; +} +static int abootimg_get_ver (int argc,char *const argv[]) {const struct andr_boot_img_hdr_v0 *hdr;
include/image.h +14 -0
@@ -1971,6 +1971,13 @@ bool is_android_vendor_boot_image_header(const void *vendor_boot_img);*/ ulong get_abootimg_addr (void ); +/** +* set_abootimg_addr() - Set Android boot image address +* +* Return: no returned results +*/ +void set_abootimg_addr (ulong addr); +/** * get_ainit_bootimg_addr() - Get Android init boot image address *
@@ -1985,6 +1992,13 @@ ulong get_ainit_bootimg_addr(void);*/ ulong get_avendor_bootimg_addr (void ); +/** +* set_abootimg_addr() - Set Android vendor boot image address +* +* Return: no returned results +*/ +void set_avendor_bootimg_addr (ulong addr); +/** * board_fit_config_name_match() - Check for a matching board name *
Signature · 1 line
2.45.2
PATCH v3 4/5 bootstd: Add a bootmeth for Android
In reply to Mattijs KorpershoekAndroid boot flow is a bit different than a regular Linux distro. Android relies on multiple partitions in order to boot.
A typical boot flow would be:
1. Parse the Bootloader Control Block (BCB, misc partition)
2. If BCB requested bootonce-bootloader, start fastboot and wait.
3. If BCB requested recovery or normal android, run the following:
3.a. Get slot (A/B) from BCB
3.b. Run AVB (Android Verified Boot) on boot partitions 3.c. Load boot and vendor_boot partitions
3.d. Load device-tree, ramdisk and boot
The AOSP documentation has more details at [1], [2], [3]
This has been implemented via complex boot scripts such as [4]. However, these boot script are neither very maintainable nor generic. Moreover, DISTRO_DEFAULTS is being deprecated [5].
Add a generic Android bootflow implementation for bootstd. For this initial version, only boot image v4 is supported.
[1] https://source.android.com/docs/core/architecture/bootloader
[2] https://source.android.com/docs/core/architecture/partitions
[3] https://source.android.com/docs/core/architecture/partitions/generic-boot
[4] https://source.denx.de/u-boot/u-boot/-/blob/master/include/configs/meson64_android.h
[5] https://lore.kernel.org/r/all/[email protected]/
--- MAINTAINERS | 7 + boot/Kconfig | 17 ++ boot/Makefile | 2 + boot/bootmeth_android.c | 553 ++++++++++++++++++++++++++++++++++++++++++++++++ boot/bootmeth_android.h | 29 +++ doc/develop/bootstd.rst | 6 + 6 files changed, 614 insertions(+)
MAINTAINERS +7 -0
@@ -939,6 +939,13 @@ F: include/bootstd.h F: net/eth_bootdevice.c F: test/boot/ +BOOTMETH_ANDROID +M: Mattijs Korpershoek <[email protected]> +S: Maintained +T: git https://source.denx.de/u-boot/custodians/u-boot-dfu.git +F: boot/bootmeth_android.c +F: boot/bootmeth_android.h + BTRFS M: Marek Behún <[email protected]> R: Qu Wenruo <[email protected]>
boot/Kconfig +17 -0
@@ -494,6 +494,23 @@ config BOOTMETH_GLOBAL EFI bootmgr, since they take full control over which bootdevs are selected to boot. +config BOOTMETH_ANDROID + bool "Bootdev support for Android" + depends on X86 || ARM || SANDBOX + depends on CMDLINE + select ANDROID_AB + select ANDROID_BOOT_IMAGE + select CMD_BCB + select CMD_FASTBOOT + select PARTITION_TYPE_GUID + select PARTITION_UUIDS + help + Enables support for booting Android using bootstd. Android requires + multiple partitions (misc, boot, vbmeta, ...) in storage for booting. + + Note that only MMC bootdevs are supported at present. This is caused + by AVB being limited to MMC devices only. + config BOOTMETH_CROS bool "Bootdev support for Chromium OS" depends on X86 || ARM || SANDBOX
boot/Makefile +2 -0
@@ -66,3 +66,5 @@ obj-$(CONFIG_$(SPL_TPL_)BOOTMETH_VBE_REQUEST) += vbe_request.o obj-$(CONFIG_$(SPL_TPL_)BOOTMETH_VBE_SIMPLE) += vbe_simple.o obj-$(CONFIG_$(SPL_TPL_)BOOTMETH_VBE_SIMPLE_FW) += vbe_simple_fw.o obj-$(CONFIG_$(SPL_TPL_)BOOTMETH_VBE_SIMPLE_OS) += vbe_simple_os.o + +obj-$(CONFIG_$(SPL_TPL_)BOOTMETH_ANDROID) += bootmeth_android.o
boot/bootmeth_android.c new file +553 -0
553 lines not on this page · raw message
boot/bootmeth_android.h new file +29 -0
@@ -0,0 +1,29 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ +/* +* Bootmethod for Android +* +* Copyright (C) 2024 BayLibre, SAS +* Written by Mattijs Korpershoek <[email protected]> +*/ + +enum android_boot_mode { +ANDROID_BOOT_MODE_NORMAL =0 , + +/* +* Android "recovery" is a special boot mode that uses another ramdisk. +* It can be used to "factory reset" a board or to flash logical partitions +* It operates in 2 modes: adb or fastbootd +* To enter recovery from Android, we can do: +* $ adb reboot recovery +* $ adb reboot fastboot +*/ +ANDROID_BOOT_MODE_RECOVERY , + +/* +* Android "bootloader" is for accessing/reflashing physical partitions +* Typically, this will launch a fastboot process in U-Boot. +* To enter "bootloader" from Android, we can do: +* $ adb reboot bootloader +*/ +ANDROID_BOOT_MODE_BOOTLOADER , +};
doc/develop/bootstd.rst +6 -0
@@ -95,6 +95,7 @@ bootflows. Note: it is possible to have a bootmeth that uses a partition or a whole device directly, but it is more common to use a filesystem. +For example, the Android bootmeth uses a whole device. Note that some bootmeths are 'global', meaning that they select the bootdev themselves. Examples include VBE and EFI boot manager. In this case, they
@@ -277,6 +278,9 @@ script_offset_f script_size_f Size of the script to load, e.g. 0x2000 +vendor_boot_comp_addr_r + Address to which to load the vendor_boot Android image, e.g. 0xe0000000 + Some variables are set by script bootmeth: devtype
@@ -418,6 +422,7 @@ Bootmeth drivers are provided for: - EFI boot using bootefi from disk - VBE - EFI boot using boot manager + - Android bootflow (boot image v4) Command interface
@@ -786,6 +791,7 @@ To do Some things that need to be done to completely replace the distro-boot scripts: - implement extensions (devicetree overlays with add-on boards) +- implement legacy (boot image v2) android boot flow Other ideas:
Signature · 1 line
2.45.2
PATCH v3 5/5 bootstd: Add test for bootmeth_android
In reply to Mattijs KorpershoekAdd a unit test for testing the Android bootmethod.
This requires another mmc image (mmc7) to contain the following partitions:
- misc: contains the Bootloader Control Block (BCB)
- boot_a: contains a fake generic kernel image
- vendor_boot_a: contains a fake vendor_boot image
Also add BOOTMETH_ANDROID as a dependency on sandbox so that we can test this with:
$ ./test/py/test.py --bd sandbox --build -k test_ut # build the mmc7.img $ ./test/py/test.py --bd sandbox --build -k bootflow_android
--- arch/sandbox/dts/test.dts | 8 +++++ configs/sandbox_defconfig | 2 +- test/boot/bootflow.c | 68 ++++++++++++++++++++++++++++++++++++++-- test/py/tests/test_ut.py | 79 +++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 153 insertions(+), 4 deletions(-)
arch/sandbox/dts/test.dts +8 -0
@@ -43,6 +43,7 @@ mmc4 = "/mmc4"; mmc5 = "/mmc5"; mmc6 = "/mmc6"; + mmc7 = "/mmc7"; pci0 = &pci0; pci1 = &pci1; pci2 = &pci2;
@@ -1129,6 +1130,13 @@ filename = "mmc6.img"; }; + /* This is used for Android tests */ + mmc7 { + status = "disabled"; + compatible = "sandbox,mmc"; + filename = "mmc7.img"; + }; + pch { compatible = "sandbox,pch"; };
configs/sandbox_defconfig +1 -1
@@ -15,6 +15,7 @@ CONFIG_FIT=y CONFIG_FIT_RSASSA_PSS=y CONFIG_FIT_CIPHER=y CONFIG_FIT_VERBOSE=y +CONFIG_BOOTMETH_ANDROID=y CONFIG_LEGACY_IMAGE_FORMAT=y CONFIG_MEASURED_BOOT=y CONFIG_BOOTSTAGE=y
@@ -40,7 +41,6 @@ CONFIG_LOG_MAX_LEVEL=9 CONFIG_LOG_DEFAULT_LEVEL=6 CONFIG_DISPLAY_BOARDINFO_LATE=y CONFIG_STACKPROTECTOR=y -CONFIG_ANDROID_AB=y CONFIG_CMD_CPU=y CONFIG_CMD_LICENSE=y CONFIG_CMD_SMBIOS=y
test/boot/bootflow.c +65 -3
104 lines not on this page · raw message
test/py/tests/test_ut.py +79 -0
97 lines not on this page · raw message
Signature · 1 line
2.45.2
Re: [PATCH v3 5/5] bootstd: Add test for bootmeth_android
Quoted 288 lines · Mattijs Korpershoek
Add a unit test for testing the Android bootmethod.
This requires another mmc image (mmc7) to contain the following partitions:
- misc: contains the Bootloader Control Block (BCB)
-boot_a: contains a fake generic kernel image
-vendor_boot_a: contains a fakevendor_bootimageAlso add
BOOTMETH_ANDROIDas a dependency on sandbox so that we can test this with:$ ./test/py/test.py --bd sandbox --build -k test_ut # build the mmc7.img $ ./test/py/test.py --bd sandbox --build -k bootflow_androidSigned-off-by Mattijs Korpershoek <[email protected]>--- arch/sandbox/dts/test.dts | 8 +++++ configs/sandbox_defconfig | 2 +- test/boot/bootflow.c | 68 ++++++++++++++++++++++++++++++++++++++-- test/py/tests/test_ut.py | 79 +++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 153 insertions(+), 4 deletions(-)arch/sandbox/dts/test.dts +8
-0@@ -43,6 +43,7 @@ mmc4 = "/mmc4"; mmc5 = "/mmc5"; mmc6 = "/mmc6"; + mmc7 = "/mmc7"; pci0 = &pci0; pci1 = &pci1; pci2 = &pci2;@@ -1129,6 +1130,13 @@ filename = "mmc6.img"; }; + /* This is used for Android tests */ + mmc7 { + status = "disabled"; + compatible = "sandbox,mmc"; + filename = "mmc7.img"; + }; + pch { compatible = "sandbox,pch"; };configs/sandbox_defconfig +1
-1@@ -15,6 +15,7 @@ CONFIG_FIT=y CONFIG_FIT_RSASSA_PSS=y CONFIG_FIT_CIPHER=y CONFIG_FIT_VERBOSE=y +CONFIG_BOOTMETH_ANDROID=y CONFIG_LEGACY_IMAGE_FORMAT=y CONFIG_MEASURED_BOOT=y CONFIG_BOOTSTAGE=y@@ -40,7 +41,6 @@ CONFIG_LOG_MAX_LEVEL=9 CONFIG_LOG_DEFAULT_LEVEL=6 CONFIG_DISPLAY_BOARDINFO_LATE=y CONFIG_STACKPROTECTOR=y -CONFIG_ANDROID_AB=y CONFIG_CMD_CPU=y CONFIG_CMD_LICENSE=y CONFIG_CMD_SMBIOS=ytest/boot/bootflow.c +65
-3@@ -27,6 +27,7 @@DECLARE_GLOBAL_DATA_PTR ; +extern U_BOOT_DRIVER (bootmeth_android);extern U_BOOT_DRIVER (bootmeth_cros);extern U_BOOT_DRIVER (bootmeth_2script);@@ -518,12 +519,12 @@ BOOTSTD_TEST(bootflow_cmd_boot, UT_TESTF_DM | UT_TESTF_SCAN_FDT);* @uts: Unit test state * @mmc_dev: MMC device to use, e.g. "mmc4". Note that this must remain valid * in the caller until -* @bind_cros: true to bind the ChromiumOS bootmeth +* @bind_cros: true to bind the ChromiumOS and Android bootmeths * @old_orderp: Returns the original bootdev order, which must be restored * Returns 0 on success, -ve on failure */ static int prep_mmc_bootdev (struct unit_test_state *uts,const char *mmc_dev, -bool bind_cros,const char ***old_orderp) +bool bind_cros_android,const char ***old_orderp) {static const char *order[] = {"mmc2" ,"mmc1" ,NULL ,NULL };struct udevice *dev, *bootstd;@@ -545,12 +546,19 @@ static int prep_mmc_bootdev(struct unit_test_state *uts, const char *mmc_dev, "bootmeth_script", 0, ofnode_null(), &dev));/* Enable the cros bootmeth if needed */ -if (IS_ENABLED (CONFIG_BOOTMETH_CROS ) && bind_cros) { +if (IS_ENABLED (CONFIG_BOOTMETH_CROS ) && bind_cros_android) {ut_assertok (uclass_first_device_err (UCLASS_BOOTSTD , &bootstd));ut_assertok (device_bind (bootstd,DM_DRIVER_REF (bootmeth_cros),"cros" ,0 ,ofnode_null (), &dev)); } +/* Enable the android bootmeths if needed */ +if (IS_ENABLED (CONFIG_BOOTMETH_ANDROID ) && bind_cros_android) { +ut_assertok (uclass_first_device_err (UCLASS_BOOTSTD , &bootstd)); +ut_assertok (device_bind (bootstd,DM_DRIVER_REF (bootmeth_android), +"android" ,0 ,ofnode_null (), &dev)); + } +/* Change the order to include the device */ std =dev_get_priv (bootstd); old_order = std->bootdev_order;@@ -589,6 +597,37 @@ static int scan_mmc_bootdev(struct unit_test_state *uts, const char *mmc_dev,return 0 ; } +/** +* scan_mmc_android_bootdev() - Set up an mmc bootdev so we can access other +* distros. Android bootflow might print "ANDROID:*" while scanning +* +* @uts: Unit test state +* @mmc_dev: MMC device to use, e.g. "mmc4" +* Returns 0 on success, -ve on failure +*/ +static int scan_mmc_android_bootdev (struct unit_test_state *uts,const char *mmc_dev) +{ +struct bootstd_priv *std; +struct udevice *bootstd; +const char **old_order; + +ut_assertok (prep_mmc_bootdev (uts, mmc_dev, true, &old_order)); + +console_record_reset_enable (); +ut_assertok (run_command ("bootflow scan" ,0 )); +/* Android bootflow might print one or two 'ANDROID:*' logs */ +ut_check_skipline (uts); +ut_check_skipline (uts); +ut_assert_console_end (); + +/* Restore the order used by the device tree */ +ut_assertok (uclass_first_device_err (UCLASS_BOOTSTD , &bootstd)); + std =dev_get_priv (bootstd); + std->bootdev_order = old_order; + +return 0 ; +} +/** * scan_mmc4_bootdev() - Set up the mmc4 bootdev so we can access a fake Armbian * @@ -1160,3 +1199,26 @@ static int bootflow_cros(struct unit_test_state *uts)return 0 ; }BOOTSTD_TEST (bootflow_cros,0 ); + +/* Test Android bootmeth */ +static int bootflow_android (struct unit_test_state *uts) +{ +if (!IS_ENABLED (CONFIG_BOOTMETH_ANDROID )) +return -EAGAIN ; + +ut_assertok (scan_mmc_android_bootdev (uts,"mmc7" )); +ut_assertok (run_command ("bootflow list" ,0 )); + +ut_assert_nextlinen ("Showing all" ); +ut_assert_nextlinen ("Seq" ); +ut_assert_nextlinen ("---" ); +ut_assert_nextlinen (" 0 extlinux" ); +ut_assert_nextlinen (" 1 android ready mmc 0 mmc7.bootdev.whole " ); +ut_assert_nextlinen ("---" ); +ut_assert_skip_to_line ("(2 bootflows, 2 valid)" ); + +ut_assert_console_end (); + +return 0 ; +} +BOOTSTD_TEST (bootflow_android,0 );test/py/tests/test_ut.py +79
-0@@ -11,6 +11,7 @@ import pytest import u_boot_utils # pylint: disable=E0611 from tests import fs_helper +from test_android import test_abootimg def mkdir_cond(dirname): """Create a directory if it doesn't already exist@@ -423,6 +424,83 @@ def setup_cros_image(cons): return fname +def setup_android_image(cons): + """Create a 20MB disk image with Android partitions""" + Partition = collections.namedtuple('part', 'start,size,name') + parts = {} + disk_data = None + + def set_part_data(partnum, data): + """Set the contents of a disk partition + + This updates disk_data by putting data in the right place + + Args: + partnum (int): Partition number to set + data (bytes): Data for that partition + """ + nonlocal disk_data + + start = parts[partnum].start * sect_size + disk_data = disk_data[:start] + data + disk_data[start + len(data):] + + mmc_dev = 7 + fname = os.path.join(cons.config.source_dir, f'mmc{mmc_dev}.img') + u_boot_utils.run_and_log(cons, 'qemu-img create %s 20M' % fname) + u_boot_utils.run_and_log(cons, f'cgpt create {fname}') + + ptr = 40 + + # Number of sectors in 1MB + sect_size = 512 + sect_1mb = (1 << 20) // sect_size + + required_parts = [ + {'num': 1, 'label':'misc', 'size': '1M'}, + {'num': 2, 'label':'boot_a', 'size': '4M'}, + {'num': 3, 'label':'boot_b', 'size': '4M'}, + {'num': 4, 'label':'vendor_boot_a', 'size': '4M'}, + {'num': 5, 'label':'vendor_boot_b', 'size': '4M'}, + ] + + for part in required_parts: + size_str = part['size'] + if 'M' in size_str: + size = int(size_str[:-1]) * sect_1mb + else: + size = int(size_str) + u_boot_utils.run_and_log( + cons, + f"cgpt add -i {part['num']} -b {ptr} -s {size} -l {part['label']} -t basicdata {fname}") + ptr += size + + u_boot_utils.run_and_log(cons, f'cgpt boot -p {fname}') + out = u_boot_utils.run_and_log(cons, f'cgpt show -q {fname}') + + # Create a dict (indexed by partition number) containing the above info + for line in out.splitlines(): + start, size, num, name = line.split(maxsplit=3) + parts[int(num)] = Partition(int(start), int(size), name) + + with open(fname, 'rb') as inf: + disk_data = inf.read() + + test_abootimg.AbootimgTestDiskImage(cons, 'bootv4.img', test_abootimg.boot_img_hex) + boot_img = os.path.join(cons.config.result_dir, 'bootv4.img') + with open(boot_img, 'rb') as inf: + set_part_data(2, inf.read()) + + test_abootimg.AbootimgTestDiskImage(cons, 'vendor_boot.img', test_abootimg.vboot_img_hex) + vendor_boot_img = os.path.join(cons.config.result_dir, 'vendor_boot.img') + with open(vendor_boot_img, 'rb') as inf: + set_part_data(4, inf.read()) + + with open(fname, 'wb') as outf: + outf.write(disk_data) + + print('wrote to {}'.format(fname)) + + return fname def setup_cedit_file(cons): infname = os.path.join(cons.config.source_dir,@@ -478,6 +556,7 @@ def test_ut_dm_init_bootstd(u_boot_console): setup_bootmenu_image(u_boot_console) setup_cedit_file(u_boot_console) setup_cros_image(u_boot_console) + setup_android_image(u_boot_console) # Restart so that the new mmc1.img is picked up u_boot_console.restart_uboot()Signature · 2 lines
-- 2.45.2
Signature · 1 line
Julien Masson
Re: [PATCH v3 5/5] bootstd: Add test for bootmeth_android
In reply to Mattijs KorpershoekLe 10/07/2024 à 10:40, Mattijs Korpershoek a écrit :
Quoted 278 lines
Add a unit test for testing the Android bootmethod.
This requires another mmc image (mmc7) to contain the following partitions:
- misc: contains the Bootloader Control Block (BCB)
-boot_a: contains a fake generic kernel image
-vendor_boot_a: contains a fakevendor_bootimageAlso add
BOOTMETH_ANDROIDas a dependency on sandbox so that we can test this with:$ ./test/py/test.py --bd sandbox --build -k test_ut # build the mmc7.img $ ./test/py/test.py --bd sandbox --build -k bootflow_androidSigned-off-by Mattijs Korpershoek <[email protected]>--- arch/sandbox/dts/test.dts | 8 +++++ configs/sandbox_defconfig | 2 +- test/boot/bootflow.c | 68 ++++++++++++++++++++++++++++++++++++++-- test/py/tests/test_ut.py | 79 +++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 153 insertions(+), 4 deletions(-)arch/sandbox/dts/test.dts +8
-0@@ -43,6 +43,7 @@ mmc4 = "/mmc4"; mmc5 = "/mmc5"; mmc6 = "/mmc6"; + mmc7 = "/mmc7"; pci0 = &pci0; pci1 = &pci1; pci2 = &pci2;@@ -1129,6 +1130,13 @@ filename = "mmc6.img"; }; + /* This is used for Android tests */ + mmc7 { + status = "disabled"; + compatible = "sandbox,mmc"; + filename = "mmc7.img"; + }; + pch { compatible = "sandbox,pch"; };configs/sandbox_defconfig +1
-1@@ -15,6 +15,7 @@ CONFIG_FIT=y CONFIG_FIT_RSASSA_PSS=y CONFIG_FIT_CIPHER=y CONFIG_FIT_VERBOSE=y +CONFIG_BOOTMETH_ANDROID=y CONFIG_LEGACY_IMAGE_FORMAT=y CONFIG_MEASURED_BOOT=y CONFIG_BOOTSTAGE=y@@ -40,7 +41,6 @@ CONFIG_LOG_MAX_LEVEL=9 CONFIG_LOG_DEFAULT_LEVEL=6 CONFIG_DISPLAY_BOARDINFO_LATE=y CONFIG_STACKPROTECTOR=y -CONFIG_ANDROID_AB=y CONFIG_CMD_CPU=y CONFIG_CMD_LICENSE=y CONFIG_CMD_SMBIOS=ytest/boot/bootflow.c +65
-3@@ -27,6 +27,7 @@DECLARE_GLOBAL_DATA_PTR ; +extern U_BOOT_DRIVER (bootmeth_android);extern U_BOOT_DRIVER (bootmeth_cros);extern U_BOOT_DRIVER (bootmeth_2script);@@ -518,12 +519,12 @@ BOOTSTD_TEST(bootflow_cmd_boot, UT_TESTF_DM | UT_TESTF_SCAN_FDT);* @uts: Unit test state * @mmc_dev: MMC device to use, e.g. "mmc4". Note that this must remain valid * in the caller until -* @bind_cros: true to bind the ChromiumOS bootmeth +* @bind_cros: true to bind the ChromiumOS and Android bootmeths * @old_orderp: Returns the original bootdev order, which must be restored * Returns 0 on success, -ve on failure */ static int prep_mmc_bootdev (struct unit_test_state *uts,const char *mmc_dev, -bool bind_cros,const char ***old_orderp) +bool bind_cros_android,const char ***old_orderp) {static const char *order[] = {"mmc2" ,"mmc1" ,NULL ,NULL };struct udevice *dev, *bootstd;@@ -545,12 +546,19 @@ static int prep_mmc_bootdev(struct unit_test_state *uts, const char *mmc_dev, "bootmeth_script", 0, ofnode_null(), &dev));/* Enable the cros bootmeth if needed */ -if (IS_ENABLED (CONFIG_BOOTMETH_CROS ) && bind_cros) { +if (IS_ENABLED (CONFIG_BOOTMETH_CROS ) && bind_cros_android) {ut_assertok (uclass_first_device_err (UCLASS_BOOTSTD , &bootstd));ut_assertok (device_bind (bootstd,DM_DRIVER_REF (bootmeth_cros),"cros" ,0 ,ofnode_null (), &dev)); } +/* Enable the android bootmeths if needed */ +if (IS_ENABLED (CONFIG_BOOTMETH_ANDROID ) && bind_cros_android) { +ut_assertok (uclass_first_device_err (UCLASS_BOOTSTD , &bootstd)); +ut_assertok (device_bind (bootstd,DM_DRIVER_REF (bootmeth_android), +"android" ,0 ,ofnode_null (), &dev)); + } +/* Change the order to include the device */ std =dev_get_priv (bootstd); old_order = std->bootdev_order;@@ -589,6 +597,37 @@ static int scan_mmc_bootdev(struct unit_test_state *uts, const char *mmc_dev,return 0 ; } +/** +* scan_mmc_android_bootdev() - Set up an mmc bootdev so we can access other +* distros. Android bootflow might print "ANDROID:*" while scanning +* +* @uts: Unit test state +* @mmc_dev: MMC device to use, e.g. "mmc4" +* Returns 0 on success, -ve on failure +*/ +static int scan_mmc_android_bootdev (struct unit_test_state *uts,const char *mmc_dev) +{ +struct bootstd_priv *std; +struct udevice *bootstd; +const char **old_order; + +ut_assertok (prep_mmc_bootdev (uts, mmc_dev, true, &old_order)); + +console_record_reset_enable (); +ut_assertok (run_command ("bootflow scan" ,0 )); +/* Android bootflow might print one or two 'ANDROID:*' logs */ +ut_check_skipline (uts); +ut_check_skipline (uts); +ut_assert_console_end (); + +/* Restore the order used by the device tree */ +ut_assertok (uclass_first_device_err (UCLASS_BOOTSTD , &bootstd)); + std =dev_get_priv (bootstd); + std->bootdev_order = old_order; + +return 0 ; +} +/** * scan_mmc4_bootdev() - Set up the mmc4 bootdev so we can access a fake Armbian * @@ -1160,3 +1199,26 @@ static int bootflow_cros(struct unit_test_state *uts)return 0 ; }BOOTSTD_TEST (bootflow_cros,0 ); + +/* Test Android bootmeth */ +static int bootflow_android (struct unit_test_state *uts) +{ +if (!IS_ENABLED (CONFIG_BOOTMETH_ANDROID )) +return -EAGAIN ; + +ut_assertok (scan_mmc_android_bootdev (uts,"mmc7" )); +ut_assertok (run_command ("bootflow list" ,0 )); + +ut_assert_nextlinen ("Showing all" ); +ut_assert_nextlinen ("Seq" ); +ut_assert_nextlinen ("---" ); +ut_assert_nextlinen (" 0 extlinux" ); +ut_assert_nextlinen (" 1 android ready mmc 0 mmc7.bootdev.whole " ); +ut_assert_nextlinen ("---" ); +ut_assert_skip_to_line ("(2 bootflows, 2 valid)" ); + +ut_assert_console_end (); + +return 0 ; +} +BOOTSTD_TEST (bootflow_android,0 );test/py/tests/test_ut.py +78
-0@@ -11,6 +11,7 @@ import pytest import u_boot_utils # pylint: disable=E0611 from tests import fs_helper +from test_android import test_abootimg def mkdir_cond(dirname): """Create a directory if it doesn't already exist@@ -423,6 +424,83 @@ def setup_cros_image(cons): return fname +def setup_android_image(cons): + """Create a 20MB disk image with Android partitions""" + Partition = collections.namedtuple('part', 'start,size,name') + parts = {} + disk_data = None + + def set_part_data(partnum, data): + """Set the contents of a disk partition + + This updates disk_data by putting data in the right place + + Args: + partnum (int): Partition number to set + data (bytes): Data for that partition + """ + nonlocal disk_data + + start = parts[partnum].start * sect_size + disk_data = disk_data[:start] + data + disk_data[start + len(data):] + + mmc_dev = 7 + fname = os.path.join(cons.config.source_dir, f'mmc{mmc_dev}.img') + u_boot_utils.run_and_log(cons, 'qemu-img create %s 20M' % fname) + u_boot_utils.run_and_log(cons, f'cgpt create {fname}') + + ptr = 40 + + # Number of sectors in 1MB + sect_size = 512 + sect_1mb = (1 << 20) // sect_size + + required_parts = [ + {'num': 1, 'label':'misc', 'size': '1M'}, + {'num': 2, 'label':'boot_a', 'size': '4M'}, + {'num': 3, 'label':'boot_b', 'size': '4M'}, + {'num': 4, 'label':'vendor_boot_a', 'size': '4M'}, + {'num': 5, 'label':'vendor_boot_b', 'size': '4M'}, + ] + + for part in required_parts: + size_str = part['size'] + if 'M' in size_str: + size = int(size_str[:-1]) * sect_1mb + else: + size = int(size_str) + u_boot_utils.run_and_log( + cons, + f"cgpt add -i {part['num']} -b {ptr} -s {size} -l {part['label']} -t basicdata {fname}") + ptr += size + + u_boot_utils.run_and_log(cons, f'cgpt boot -p {fname}') + out = u_boot_utils.run_and_log(cons, f'cgpt show -q {fname}') + + # Create a dict (indexed by partition number) containing the above info + for line in out.splitlines(): + start, size, num, name = line.split(maxsplit=3) + parts[int(num)] = Partition(int(start), int(size), name) + + with open(fname, 'rb') as inf: + disk_data = inf.read() + + test_abootimg.AbootimgTestDiskImage(cons, 'bootv4.img', test_abootimg.boot_img_hex) + boot_img = os.path.join(cons.config.result_dir, 'bootv4.img') + with open(boot_img, 'rb') as inf: + set_part_data(2, inf.read()) + + test_abootimg.AbootimgTestDiskImage(cons, 'vendor_boot.img', test_abootimg.vboot_img_hex) + vendor_boot_img = os.path.join(cons.config.result_dir, 'vendor_boot.img') + with open(vendor_boot_img, 'rb') as inf: + set_part_data(4, inf.read()) + + with open(fname, 'wb') as outf: + outf.write(disk_data) + + print('wrote to {}'.format(fname)) + + return fname def setup_cedit_file(cons): infname = os.path.join(cons.config.source_dir,
test/py/tests/test_ut.py def test_ut_dm_init_bootstd(u_boot_console): · line 562
Quoted 7 lines
test/py/tests/test_ut.py +1
-0@@ -478,6 +556,7 @@ def test_ut_dm_init_bootstd(u_boot_console): setup_bootmenu_image(u_boot_console) setup_cedit_file(u_boot_console) setup_cros_image(u_boot_console) + setup_android_image(u_boot_console) # Restart so that the new mmc1.img is picked up u_boot_console.restart_uboot()
Re: [PATCH v3 5/5] bootstd: Add test for bootmeth_android
In reply to Mattijs KorpershoekQuoted 14 lines · Mattijs Korpershoek
Add a unit test for testing the Android bootmethod.
This requires another mmc image (mmc7) to contain the following partitions:
- misc: contains the Bootloader Control Block (BCB)
-boot_a: contains a fake generic kernel image
-vendor_boot_a: contains a fakevendor_bootimageAlso add
BOOTMETH_ANDROIDas a dependency on sandbox so that we can test this with:$ ./test/py/test.py --bd sandbox --build -k test_ut # build the mmc7.img $ ./test/py/test.py --bd sandbox --build -k bootflow_android
Quoted 7 lines
Signed-off-by Mattijs Korpershoek <[email protected]>--- arch/sandbox/dts/test.dts | 8 +++++ configs/sandbox_defconfig | 2 +- test/boot/bootflow.c | 68 ++++++++++++++++++++++++++++++++++++++-- test/py/tests/test_ut.py | 79 +++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 153 insertions(+), 4 deletions(-)
Quoted 12 lines · Mattijs Korpershoek
Android boot flow is a bit different than a regular Linux distro. Android relies on multiple partitions in order to boot.
A typical boot flow would be:
1. Parse the Bootloader Control Block (BCB, misc partition)
2. If BCB requested bootonce-bootloader, start fastboot and wait.
3. If BCB requested recovery or normal android, run the following:
a. Get slot (A/B) from BCB
b. Run AVB (Android Verified Boot) on boot partitions c. Load boot andvendor_bootpartitions
d. Load device-tree, ramdisk and boot
Quoted 1 line
[...]
Applied to u-boot/master, thanks!
Signature · 1 line
Tom