qbootctl/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)
    -i               still write the GPT headers even if the UFS bLun can't be changed (default: false)
```

## 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! 3 years ago			`# 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. 3 years ago
			`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! 3 years ago			`## 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. 3 years ago
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! 3 years ago			`* 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. 3 years ago			`* meson`
			`* cmake`
			`* linux-headers`
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! 3 years ago
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. 3 years ago			`## Building`

			`qbootctl uses the meson build system`
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! 3 years ago
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. 3 years ago			```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! 3 years ago			```
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. 3 years ago
			`## Usage`

			```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! 3 years ago			`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)`
add a flag to continue when ufs bsg device is missing For some usecases it is desired to still update the GPT headers even if the UFS BSG device is missing. Add a new flag which implements this behaviour. It isn't made the default because on some platforms this could result in an unbootable device, there it's preferable to defer to the user by just bailing out if the UFS BSG device is unavailable. Signed-off-by: Caleb Connolly <caleb@connolly.tech> 1 year ago			`-i still write the GPT headers even if the UFS bLun can't be changed (default: false)`
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! 3 years ago			```

			`## 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). 3 years ago
			`## 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):`