diff --git a/README.md b/README.md index e814fdc..ac04e27 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,39 @@ # XCReader -## Introduction +## Description -QC starts using a new format of XBL config since 8450 platforms. The new format designed for it is to store some -important configurations like `XBL DTB`, `CPR`, and `DCB`. -This tool is aim to extract those files from the XBL config. -:::tip -This tool only works on SM8450 and subsequent platforms. -::: +Qualcomm makes use of a eXtended Boot Loader configuration binary (`xbl_config`) starting with SM8450 and later hardware platforms. -## How to use +The eXtended Boot Loader configuration binary is intended to store important configuration data, previously found on older platforms within plain text cfg files, such as: -- Just run it in a terminal will be fine. -- xbl_config.img is also acceptable. +- `XBL DTB` +- `CPR` +- `DCB` -``` +This tool allows the extraction of the eXtended Boot Loader configuration data for these hardware platforms, using the `xbl_config` ELF or partition binary as input. + +> [!TIP] +> This tool only works on SM8450+ based platforms. + +## Usage + +- Command Line Tool only, run it from a Terminal or Console Application. +- Provide the path to `xbl_config.elf`, please note that `xbl_config.img` (partition copy of `xbl_config.elf` with extra blank padding) is also handled fine by the tool. + +```bash Usage: ``` ## Build -- Need cmake and C toolchain. -``` + +Prerequisites: + +- `CMake` +- `C Toolchain`. + +```bash git clone https://github.com/woa-msmnile/XBLConfigReader --depth=1 cd XBLConfigReader mkdir build && cd build cmake -S .. && cmake --build . -``` \ No newline at end of file +```