Blame view
include/android_bootloader_message.h
10.5 KB
27d156118
|
1 2 3 4 |
/* * This is from the Android Project, * Repository: https://android.googlesource.com/platform/bootable/recovery * File: bootloader_message/include/bootloader_message/bootloader_message.h |
0381b713d
|
5 |
* Commit: See U-Boot commit description |
27d156118
|
6 7 8 9 10 11 12 13 |
* * Copyright (C) 2008 The Android Open Source Project * * SPDX-License-Identifier: BSD-3-Clause */ #ifndef __ANDROID_BOOTLOADER_MESSAGE_H #define __ANDROID_BOOTLOADER_MESSAGE_H |
0381b713d
|
14 15 16 17 18 |
#ifndef __UBOOT__ #include <assert.h> #include <stddef.h> #include <stdint.h> #else |
27d156118
|
19 20 21 22 |
/* compiler.h defines the types that otherwise are included from stdint.h and * stddef.h */ #include <compiler.h> |
0381b713d
|
23 |
#endif |
27d156118
|
24 |
|
0381b713d
|
25 26 27 28 29 |
// Spaces used by misc partition are as below: // 0 - 2K For bootloader_message // 2K - 16K Used by Vendor's bootloader (the 2K - 4K range may be optionally used // as bootloader_message_ab struct) // 16K - 64K Used by uncrypt and recovery to store wipe_package for A/B devices |
7fd03bcc8
|
30 |
// 32K - 64K System space, used for miscellanious AOSP features. See below. |
0381b713d
|
31 32 |
// Note that these offsets are admitted by bootloader,recovery and uncrypt, so they // are not configurable without changing all of them. |
27d156118
|
33 34 |
static const size_t BOOTLOADER_MESSAGE_OFFSET_IN_MISC = 0; static const size_t WIPE_PACKAGE_OFFSET_IN_MISC = 16 * 1024; |
7fd03bcc8
|
35 |
static const size_t SYSTEM_SPACE_SIZE_IN_MISC = 32 * 1024; |
27d156118
|
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
/* Bootloader Message (2-KiB) * * This structure describes the content of a block in flash * that is used for recovery and the bootloader to talk to * each other. * * The command field is updated by linux when it wants to * reboot into recovery or to update radio or bootloader firmware. * It is also updated by the bootloader when firmware update * is complete (to boot into recovery for any final cleanup) * * The status field was used by the bootloader after the completion * of an "update-radio" or "update-hboot" command, which has been * deprecated since Froyo. * * The recovery field is only written by linux and used * for the system to send a message to recovery or the * other way around. * * The stage field is written by packages which restart themselves * multiple times, so that the UI can reflect which invocation of the * package it is. If the value is of the format "#/#" (eg, "1/3"), * the UI will add a simple indicator of that status. * * We used to have slot_suffix field for A/B boot control metadata in * this struct, which gets unintentionally cleared by recovery or * uncrypt. Move it into struct bootloader_message_ab to avoid the * issue. */ struct bootloader_message { char command[32]; char status[32]; char recovery[768]; |
0381b713d
|
70 71 72 73 74 |
// The 'recovery' field used to be 1024 bytes. It has only ever // been used to store the recovery command line, so 768 bytes // should be plenty. We carve off the last 256 bytes to store the // stage string (for multistage packages) and possible future // expansion. |
27d156118
|
75 |
char stage[32]; |
0381b713d
|
76 77 78 79 |
// The 'reserved' field used to be 224 bytes when it was initially // carved off from the 1024-byte recovery field. Bump it up to // 1184-byte so that the entire bootloader_message struct rounds up // to 2048-byte. |
27d156118
|
80 81 82 83 84 85 86 |
char reserved[1184]; }; /** * We must be cautious when changing the bootloader_message struct size, * because A/B-specific fields may end up with different offsets. */ |
0381b713d
|
87 |
#ifndef __UBOOT__ |
27d156118
|
88 89 90 91 |
#if (__STDC_VERSION__ >= 201112L) || defined(__cplusplus) static_assert(sizeof(struct bootloader_message) == 2048, "struct bootloader_message size changes, which may break A/B devices"); #endif |
0381b713d
|
92 |
#endif /* __UBOOT__ */ |
27d156118
|
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
/** * The A/B-specific bootloader message structure (4-KiB). * * We separate A/B boot control metadata from the regular bootloader * message struct and keep it here. Everything that's A/B-specific * stays after struct bootloader_message, which should be managed by * the A/B-bootloader or boot control HAL. * * The slot_suffix field is used for A/B implementations where the * bootloader does not set the androidboot.ro.boot.slot_suffix kernel * commandline parameter. This is used by fs_mgr to mount /system and * other partitions with the slotselect flag set in fstab. A/B * implementations are free to use all 32 bytes and may store private * data past the first NUL-byte in this field. It is encouraged, but * not mandatory, to use 'struct bootloader_control' described below. * * The update_channel field is used to store the Omaha update channel * if update_engine is compiled with Omaha support. */ struct bootloader_message_ab { struct bootloader_message message; char slot_suffix[32]; char update_channel[128]; |
0381b713d
|
117 |
// Round up the entire struct to 4096-byte. |
27d156118
|
118 119 120 121 122 123 124 |
char reserved[1888]; }; /** * Be cautious about the struct size change, in case we put anything post * bootloader_message_ab struct (b/29159185). */ |
0381b713d
|
125 |
#ifndef __UBOOT__ |
27d156118
|
126 127 128 129 |
#if (__STDC_VERSION__ >= 201112L) || defined(__cplusplus) static_assert(sizeof(struct bootloader_message_ab) == 4096, "struct bootloader_message_ab size changes"); #endif |
0381b713d
|
130 |
#endif /* __UBOOT__ */ |
27d156118
|
131 132 133 134 135 |
#define BOOT_CTRL_MAGIC 0x42414342 /* Bootloader Control AB */ #define BOOT_CTRL_VERSION 1 struct slot_metadata { |
0381b713d
|
136 137 |
// Slot priority with 15 meaning highest priority, 1 lowest // priority and 0 the slot is unbootable. |
27d156118
|
138 |
uint8_t priority : 4; |
0381b713d
|
139 |
// Number of times left attempting to boot this slot. |
27d156118
|
140 |
uint8_t tries_remaining : 3; |
0381b713d
|
141 |
// 1 if this slot has booted successfully, 0 otherwise. |
27d156118
|
142 |
uint8_t successful_boot : 1; |
0381b713d
|
143 144 |
// 1 if this slot is corrupted from a dm-verity corruption, 0 // otherwise. |
27d156118
|
145 |
uint8_t verity_corrupted : 1; |
f5cda163c
|
146 147 148 149 150 151 152 |
#ifdef CONFIG_DUAL_BOOTLOADER // 1 if the bootloader has been verified in spl stage, 0 otherwise. // this is needed for dual bootloader case. uint8_t bootloader_verified : 1; // Reserved for further use. uint8_t reserved : 6; #else |
0381b713d
|
153 |
// Reserved for further use. |
27d156118
|
154 |
uint8_t reserved : 7; |
f5cda163c
|
155 |
#endif |
27d156118
|
156 157 158 159 160 161 162 163 164 165 166 |
} __attribute__((packed)); /* Bootloader Control AB * * This struct can be used to manage A/B metadata. It is designed to * be put in the 'slot_suffix' field of the 'bootloader_message' * structure described above. It is encouraged to use the * 'bootloader_control' structure to store the A/B metadata, but not * mandatory. */ struct bootloader_control { |
0381b713d
|
167 |
// NUL terminated active slot suffix. |
27d156118
|
168 |
char slot_suffix[4]; |
0381b713d
|
169 |
// Bootloader Control AB magic number (see BOOT_CTRL_MAGIC). |
27d156118
|
170 |
uint32_t magic; |
0381b713d
|
171 |
// Version of struct being used (see BOOT_CTRL_VERSION). |
27d156118
|
172 |
uint8_t version; |
0381b713d
|
173 |
// Number of slots being managed. |
27d156118
|
174 |
uint8_t nb_slot : 3; |
0381b713d
|
175 |
// Number of times left attempting to boot recovery. |
27d156118
|
176 |
uint8_t recovery_tries_remaining : 3; |
0381b713d
|
177 |
// Ensure 4-bytes alignment for slot_info field. |
27d156118
|
178 |
uint8_t reserved0[2]; |
0381b713d
|
179 |
// Per-slot information. Up to 4 slots. |
27d156118
|
180 |
struct slot_metadata slot_info[4]; |
f5cda163c
|
181 182 183 184 185 186 187 188 |
#ifdef CONFIG_DUAL_BOOTLOADER //Last boot slot uint8_t last_boot; //spl recovery mode bool spl_recovery; // Reserved for further use. uint8_t reserved1[6]; #else |
0381b713d
|
189 |
// Reserved for further use. |
27d156118
|
190 |
uint8_t reserved1[8]; |
f5cda163c
|
191 |
#endif |
0381b713d
|
192 193 |
// CRC32 of all 28 bytes preceding this field (little endian // format). |
27d156118
|
194 195 |
uint32_t crc32_le; } __attribute__((packed)); |
0381b713d
|
196 |
#ifndef __UBOOT__ |
27d156118
|
197 198 199 200 201 |
#if (__STDC_VERSION__ >= 201112L) || defined(__cplusplus) static_assert(sizeof(struct bootloader_control) == sizeof(((struct bootloader_message_ab *)0)->slot_suffix), "struct bootloader_control has wrong size"); #endif |
0381b713d
|
202 |
#endif /* __UBOOT__ */ |
27d156118
|
203 |
|
7fd03bcc8
|
204 205 206 207 208 209 210 211 212 213 |
typedef struct misc_virtual_ab_message { uint8_t version; uint32_t magic; uint8_t merge_status; // IBootControl 1.1, MergeStatus enum. uint8_t source_slot; // Slot number when merge_status was written. uint8_t reserved[57]; } __attribute__((packed)) misc_virtual_ab_message; #define MISC_VIRTUAL_AB_MESSAGE_VERSION 2 #define MISC_VIRTUAL_AB_MAGIC_HEADER 0x56740AB0 |
27d156118
|
214 |
#ifndef __UBOOT__ |
27d156118
|
215 216 217 218 |
#ifdef __cplusplus #include <string> #include <vector> |
0381b713d
|
219 220 221 |
// Return the block device name for the bootloader message partition and waits // for the device for up to 10 seconds. In case of error returns the empty // string. |
27d156118
|
222 |
std::string get_bootloader_message_blk_device(std::string* err); |
0381b713d
|
223 |
// Read bootloader message into boot. Error message will be set in err. |
27d156118
|
224 |
bool read_bootloader_message(bootloader_message* boot, std::string* err); |
0381b713d
|
225 |
// Read bootloader message from the specified misc device into boot. |
27d156118
|
226 227 |
bool read_bootloader_message_from(bootloader_message* boot, const std::string& misc_blk_device, std::string* err); |
0381b713d
|
228 |
// Write bootloader message to BCB. |
27d156118
|
229 |
bool write_bootloader_message(const bootloader_message& boot, std::string* err); |
0381b713d
|
230 |
// Write bootloader message to the specified BCB device. |
27d156118
|
231 232 |
bool write_bootloader_message_to(const bootloader_message& boot, const std::string& misc_blk_device, std::string* err); |
0381b713d
|
233 234 |
// Write bootloader message (boots into recovery with the options) to BCB. Will // set the command and recovery fields, and reset the rest. |
27d156118
|
235 |
bool write_bootloader_message(const std::vector<std::string>& options, std::string* err); |
0381b713d
|
236 237 |
// Write bootloader message (boots into recovery with the options) to the specific BCB device. Will // set the command and recovery fields, and reset the rest. |
27d156118
|
238 239 |
bool write_bootloader_message_to(const std::vector<std::string>& options, const std::string& misc_blk_device, std::string* err); |
0381b713d
|
240 241 |
// Update bootloader message (boots into recovery with the options) to BCB. Will // only update the command and recovery fields. |
27d156118
|
242 |
bool update_bootloader_message(const std::vector<std::string>& options, std::string* err); |
0381b713d
|
243 244 |
// Update bootloader message (boots into recovery with the |options|) in |boot|. Will only update // the command and recovery fields. |
27d156118
|
245 246 |
bool update_bootloader_message_in_struct(bootloader_message* boot, const std::vector<std::string>& options); |
0381b713d
|
247 |
// Clear BCB. |
27d156118
|
248 |
bool clear_bootloader_message(std::string* err); |
0381b713d
|
249 |
// Writes the reboot-bootloader reboot reason to the bootloader_message. |
27d156118
|
250 |
bool write_reboot_bootloader(std::string* err); |
0381b713d
|
251 |
// Read the wipe package from BCB (from offset WIPE_PACKAGE_OFFSET_IN_MISC). |
27d156118
|
252 |
bool read_wipe_package(std::string* package_data, size_t size, std::string* err); |
0381b713d
|
253 |
// Write the wipe package into BCB (to offset WIPE_PACKAGE_OFFSET_IN_MISC). |
27d156118
|
254 255 256 257 258 |
bool write_wipe_package(const std::string& package_data, std::string* err); #else #include <stdbool.h> |
0381b713d
|
259 |
// C Interface. |
27d156118
|
260 261 |
bool write_bootloader_message(const char* options); bool write_reboot_bootloader(void); |
0381b713d
|
262 |
#endif // ifdef __cplusplus |
27d156118
|
263 264 265 |
#endif /* __UBOOT__ */ #endif /* __ANDROID_BOOTLOADER_MESSAGE_H */ |