tag/0.1.2/README.md

# Qualcomm bootctl HAL for Linux

This HAL was pulled from AOSP source code and bastardised to build and run on a musl/glibc system. This may or may not render any hardware you run it on unusable, you have been warned.

## Dependencies

* zlib-dev
* meson
* cmake
* linux-headers

## Building

qbootctl uses the meson build system

```sh
meson build
meson compile -C build
```

## Usage

```text
qbootctl: qcom bootctrl HAL port for Linux
-------------------------------------------
qbootctl [-c|-m|-s|-u|-b|-n|-x] [SLOT]

    <no args>        dump slot info (default)
    -h               this help text
    -c               get the current slot
    -b SLOT          check if SLOT is marked as bootable
    -n SLOT          check if SLOT is marked as successful
    -x [SLOT]        get the slot suffix for SLOT (default: current)
    -s SLOT          set to active slot to SLOT
    -m [SLOT]        mark a boot as successful (default: current)
    -u [SLOT]        mark SLOT as unbootable (default: current)
```

## Debugging

Set `DEBUG` to 1 in `utils.h` to enable debug logging.

## Documentation

A more details explanation and a list of devices where qbootctl has been
validated can be found [on the postmarketOS wiki](https://wiki.postmarketos.org/wiki/Android_AB_Slots):
its ALIIIIIIVE not yet properly tested, but it seems to mostly work just fine. Slot switching and marking boot as successful at least just work! 2022-06-04 04:42:40 +01:00			`# Qualcomm bootctl HAL for Linux`
initial commit This is a port of the Android bootctrl HAL and Qualcomms GPT based implementation for musl/glibc based systems running mainline linux Currently it doesn't work because the gpt hdr which is read doesn't seem to have valid data. 2021-10-09 23:16:20 +01:00
			`This HAL was pulled from AOSP source code and bastardised to build and run on a musl/glibc system. This may or may not render any hardware you run it on unusable, you have been warned.`

its ALIIIIIIVE not yet properly tested, but it seems to mostly work just fine. Slot switching and marking boot as successful at least just work! 2022-06-04 04:42:40 +01:00			`## Dependencies`
initial commit This is a port of the Android bootctrl HAL and Qualcomms GPT based implementation for musl/glibc based systems running mainline linux Currently it doesn't work because the gpt hdr which is read doesn't seem to have valid data. 2021-10-09 23:16:20 +01:00
its ALIIIIIIVE not yet properly tested, but it seems to mostly work just fine. Slot switching and marking boot as successful at least just work! 2022-06-04 04:42:40 +01:00			`* zlib-dev`
cleanup, stub out tests not sure how best to write tests, probably a larger test framework on a board farm to test on real devices will be more sensible. 2022-06-04 15:51:22 +01:00			`* meson`
			`* cmake`
			`* linux-headers`

			`## Building`

			`qbootctl uses the meson build system`

			```sh
			`meson build`
			`meson compile -C build`
			```
its ALIIIIIIVE not yet properly tested, but it seems to mostly work just fine. Slot switching and marking boot as successful at least just work! 2022-06-04 04:42:40 +01:00
			`## Usage`

cleanup, stub out tests not sure how best to write tests, probably a larger test framework on a board farm to test on real devices will be more sensible. 2022-06-04 15:51:22 +01:00			```text
its ALIIIIIIVE not yet properly tested, but it seems to mostly work just fine. Slot switching and marking boot as successful at least just work! 2022-06-04 04:42:40 +01:00			`qbootctl: qcom bootctrl HAL port for Linux`
			`-------------------------------------------`
			`qbootctl [-c\|-m\|-s\|-u\|-b\|-n\|-x] [SLOT]`

			`<no args> dump slot info (default)`
			`-h this help text`
			`-c get the current slot`
			`-b SLOT check if SLOT is marked as bootable`
			`-n SLOT check if SLOT is marked as successful`
			`-x [SLOT] get the slot suffix for SLOT (default: current)`
			`-s SLOT set to active slot to SLOT`
			`-m [SLOT] mark a boot as successful (default: current)`
			`-u [SLOT] mark SLOT as unbootable (default: current)`
			```

			`## Debugging`

			Set `DEBUG` to 1 in `utils.h` to enable debug logging.
minor cleanups, improve error handling gracefully handle UFS_BSG not being enabled in the kernel, rather than putting the device into a semi-bricked state (oops). 2022-06-10 19:18:13 +01:00
			`## Documentation`

			`A more details explanation and a list of devices where qbootctl has been`
			`validated can be found [on the postmarketOS wiki](https://wiki.postmarketos.org/wiki/Android_AB_Slots):`