Skip to content

Commit 536e34b

Browse files
authored
Improve README
1 parent 0f4eec6 commit 536e34b

File tree

1 file changed

+25
-14
lines changed

1 file changed

+25
-14
lines changed

README.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,39 @@
11
# XCReader
22

3-
## Introduction
3+
## Description
44

5-
QC starts using a new format of XBL config since 8450 platforms. The new format designed for it is to store some
6-
important configurations like `XBL DTB`, `CPR`, and `DCB`.
7-
This tool is aim to extract those files from the XBL config.
8-
:::tip
9-
This tool only works on SM8450 and subsequent platforms.
10-
:::
5+
Qualcomm makes use of a eXtended Boot Loader configuration binary (`xbl_config`) starting with SM8450 and later hardware platforms.
116

12-
## How to use
7+
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:
138

14-
- Just run it in a terminal will be fine.
15-
- xbl_config.img is also acceptable.
9+
- `XBL DTB`
10+
- `CPR`
11+
- `DCB`
1612

17-
```
13+
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.
14+
15+
> [!TIP]
16+
> This tool only works on SM8450+ based platforms.
17+
18+
## Usage
19+
20+
- Command Line Tool only, run it from a Terminal or Console Application.
21+
- 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.
22+
23+
```bash
1824
Usage: <Path to xbl_config.elf> <Output Directory>
1925
```
2026

2127
## Build
22-
- Need cmake and C toolchain.
23-
```
28+
29+
Prerequisites:
30+
31+
- `CMake`
32+
- `C Toolchain`.
33+
34+
```bash
2435
git clone https://github.com/woa-msmnile/XBLConfigReader --depth=1
2536
cd XBLConfigReader
2637
mkdir build && cd build
2738
cmake -S .. && cmake --build .
28-
```
39+
```

0 commit comments

Comments
 (0)