aospdtgen

Use aospdtgen to create a device tree from an Android stock ROM dump.

Requirements:

• The dump must be created using dumpyara.
• The device must be Treble-enabled (Android 8.0+ with VNDK enabled). You can verify Treble status via adb shell getprop ro.treble.enabled or using the Treble Info app.
• For pre-Treble devices, use twrpdtgen instead.

python -m aospdtgen [options] dump_path

Install the aospdtgen package using pip. This tool requires Python 3.9 or greater.

pip install aospdtgen

The cleanup method removes temporary files created during the parsing process (specifically via BootConfiguration).

Note: After calling cleanup(), the DeviceTree instance should be considered invalid and should not be used further.

def cleanup(self) -> None:

The DeviceTree class is the primary entry point for generating an Android device tree from a dumpyara dump. When initialized, it parses the dump to identify partitions, build properties, device information, fstab entries, and boot configurations.

To use it, instantiate DeviceTree with the path to your dump, then call dump_to_folder to write the generated makefiles, blueprints, and prebuilt files to a target directory.

from pathlib import Path
from aospdtgen.device_tree import DeviceTree

# Initialize with the path to a dumpyara dump
dt = DeviceTree(Path("/path/to/dump"))

# Generate the device tree files in a specific folder
dt.dump_to_folder(Path("/path/to/output_folder"))

# Clean up temporary files
dt.cleanup()

The following arguments and flags are available for the aospdtgen CLI tool:

dump_path (Path)             # path to an Android dump made with dumpyara
-o, --output (Path)          # custom output folder (default: current_path / "output")
--no-proprietary-files        # Don't generate the proprietary files list and the extract-files script

You can execute the aospdtgen tool as a Python module using the -m flag. This invokes the main() function from aospdtgen.main, which serves as the primary entrypoint for the command-line interface.

python3 -m aospdtgen

The aospdtgen command-line tool generates an Android device tree from a dump created with dumpyara.

Usage: python -m aospdtgen <dump_path> [options]

Arguments:

• dump_path (Positional): The path to the Android dump directory/file created using dumpyara.

Options:

• -o, --output: Specifies a custom output folder for the generated device tree. If not provided, it defaults to an output folder in the current working directory.
• --no-proprietary-files: If this flag is set, the tool will skip generating the proprietary files list and the extract-files script.

python -m aospdtgen /path/to/dumpyara_dump -o /path/to/output_dir

The DeviceTree constructor parses a dumpyara dump at the provided path.

Parameters:

• path (Path): The filesystem path to the dumpyara dump.
• no_proprietary_files (bool): If set to True, the ProprietaryFilesList will not be generated. Defaults to False.

Internal State Created:

• self.partitions: A Partitions object representing the device's partition scheme.
• self.device_info: DeviceInfo extracted from build properties.
• self.fstab: The parsed Fstab object.
• self.boot_configuration: BootConfiguration extracted from the boot image.
• self.proprietary_files_list: An optional ProprietaryFilesList containing the list of proprietary files.

DeviceTree(path: Path, no_proprietary_files: bool = False)