Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 3.79 KB

README.md

File metadata and controls

96 lines (67 loc) · 3.79 KB
Raw

adevtool

Android ROM device support and bringup tool, designed for maximum automation and speed.

Demo video on asciinema

Features

This tool automates the following tasks for devices that mostly run AOSP out-of-the-box (e.g. Google Pixel):

  • Downloading factory images and full OTA packages
  • Generating a list of proprietary files
  • Resolving overridden build rules and building modules from source (when possible)
  • Extracting, converting, and mounting factory images (supported source formats)
  • Extracting proprietary files
  • Extracting bootloader and radio firmware
  • Finding and adding missing system properties
  • Overriding build fingerprint to help pass SafetyNet
  • Adding missing SELinux policies
  • Adding missing HALs to vendor interface manifests
  • Generating resource overlays for device configs
  • Fixing privileged app signing certificates referenced in SELinux policies

This typically results in better device support with fewer bugs and issues, and makes it possible to quickly add support for new devices.

Example generated vendor modules for Pixel devices

Non-AOSP devices

Pixel devices will benefit from the most automation, but several features can still be used to ease manual bringup on other devices:

  • Extract files from proprietary-files.txt up to 2000% faster than LineageOS extract-utils (speed comparison)
    • LineageOS extract-utils: 1 min 27 sec
    • adevtool: 4 sec
    • Tested with Pixel 5 (redfin), cache cleared before testing
  • Compare a built system against stock images to find missing files, properties, and vendor interface declarations
  • List system files relevant to bringup (in all partitions)
  • Resolve overridden build rules from build warnings
  • Check SELinux policies to identify apps that should be presigned

Installation

Pre-requisites:

  • Node.js v18 or newer (older versions will not work)
  • Optional:
    • For converting sparse factory images: simg2img
    • For extracting OTA packages: payload-dumper-go
    • For extracting OTAs or factory images: unzip
    • For generating overlays: AAPT2 (included in AOSP and Android SDK)

To run adevtool without installation:

npx adevtool

To install adevtool globally using npm:

npm install -g adevtool

Using Yarn:

yarn global add adevtool

Usage

Why TypeScript?

TypeScript is not a common language for Android-related tools, but I picked it for several reasons:

  • Fast (enough) and easily parallelizable
  • Good static type system (for developer experience: fewer bugs and better editor code intelligence)
  • Good libraries for friendly CLI interfaces with pretty output
  • Relatively lightweight

Why not...

  • Python: May not meet speed/parallelization goals easily, types aren't as nice
  • Kotlin: Requires big+heavy JVM to run, CLI libraries aren't as good
  • Go: Good choice overall, but error checking can be overly verbose

Overall, TypeScript is a decent compromise on all of these points.

License

This tool is licensed under the MIT license, ensuring that anyone is free to use it for any purpose in compliance with the license. Contributions are welcome!