GBL Documentation

This directory contains documentation for the Generic Bootloader (GBL).

Table of Contents

General Documentation

• UEFI Overview: Lists the UEFI protocols and interfaces used by GBL.
• A/B Boot Flow: Explains GBL's A/B boot logic.
• Android Boot Flow: Explains GBL's Android boot flow.
• Buffer Usage: Discusses memory buffer management.
• Fastboot: Describes GBL's Fastboot implementation.
• FIT Image Handling: Details how FIT images are processed.
• Partition Management: Details how GBL handles disk partitions.

Custom UEFI Protocols

• Android Verified Boot Protocol (GBL_EFI_AVB_PROTOCOL)
• AVF Protocol (GBL_EFI_AVF_PROTOCOL)
• Boot Control Protocol (GBL_EFI_BOOT_CONTROL_PROTOCOL)
• Boot Memory Protocol (GBL_EFI_BOOT_MEMORY_PROTOCOL)
• Debug Protocol (GBL_EFI_DEBUG_PROTOCOL)
• Fastboot Protocol (GBL_EFI_FASTBOOT_PROTOCOL)
• Fastboot Transport Protocol (GBL_EFI_FASTBOOT_TRANSPORT_PROTOCOL)
• OS Configuration Protocol (GBL_EFI_OS_CONFIGURATION_PROTOCOL)

Formatting

GBL documentation uses Prettier to ensure consistent formatting across GBL source and documentation files. Example command:

prettier --write ./bootable/libbootloader/gbl/**/*.md