Blame view
include/android_image.h
5.64 KB
0b6febfdb Update include/an... |
1 |
/* SPDX-License-Identifier: BSD-3-Clause */ |
9ace3fc81 image: add suppor... |
2 3 |
/* * This is from the Android Project, |
0b6febfdb Update include/an... |
4 5 6 |
* Repository: https://android.googlesource.com/platform/system/tools/mkbootimg * File: include/bootimg/bootimg.h * Commit: e55998a0f2b61b685d5eb4a486ca3a0c680b1a2f |
9ace3fc81 image: add suppor... |
7 |
* |
0b6febfdb Update include/an... |
8 |
* Copyright (C) 2007 The Android Open Source Project |
9ace3fc81 image: add suppor... |
9 10 11 12 |
*/ #ifndef _ANDROID_IMAGE_H_ #define _ANDROID_IMAGE_H_ |
35e99836c image: android: F... |
13 14 |
#include <linux/compiler.h> #include <linux/types.h> |
9ace3fc81 image: add suppor... |
15 16 17 18 |
#define ANDR_BOOT_MAGIC "ANDROID!" #define ANDR_BOOT_MAGIC_SIZE 8 #define ANDR_BOOT_NAME_SIZE 16 #define ANDR_BOOT_ARGS_SIZE 512 |
210a7176e image: Update inc... |
19 |
#define ANDR_BOOT_EXTRA_ARGS_SIZE 1024 |
9ace3fc81 image: add suppor... |
20 |
|
0b6febfdb Update include/an... |
21 22 |
/* The bootloader expects the structure of andr_img_hdr with header * version 0 to be as follows: */ |
a2018ab0d MLK-18591-3 andro... |
23 24 25 26 27 28 29 30 31 32 33 34 |
/* Boot metric variables (in millisecond) */ struct boot_metric { u32 bll_1; /* 1th bootloader load duration */ u32 ble_1; /* 1th bootloader exec duration */ u32 kl; /* kernel image load duration */ u32 kd; /* kernel image decompress duration */ u32 avb; /* avb verify boot.img duration */ u32 odt; /* overlay device tree duration */ u32 sw; /* system wait for UI interaction duration*/ }; typedef struct boot_metric boot_metric; |
9ace3fc81 image: add suppor... |
35 |
struct andr_img_hdr { |
0b6febfdb Update include/an... |
36 37 |
/* Must be ANDR_BOOT_MAGIC. */ char magic[ANDR_BOOT_MAGIC_SIZE]; |
9ace3fc81 image: add suppor... |
38 |
|
0b6febfdb Update include/an... |
39 40 |
u32 kernel_size; /* size in bytes */ u32 kernel_addr; /* physical load addr */ |
9ace3fc81 image: add suppor... |
41 |
|
0b6febfdb Update include/an... |
42 43 |
u32 ramdisk_size; /* size in bytes */ u32 ramdisk_addr; /* physical load addr */ |
9ace3fc81 image: add suppor... |
44 |
|
0b6febfdb Update include/an... |
45 46 |
u32 second_size; /* size in bytes */ u32 second_addr; /* physical load addr */ |
9ace3fc81 image: add suppor... |
47 |
|
0b6febfdb Update include/an... |
48 49 |
u32 tags_addr; /* physical addr for kernel tags */ u32 page_size; /* flash page size we assume */ |
210a7176e image: Update inc... |
50 |
|
0b6febfdb Update include/an... |
51 52 |
/* Version of the boot image header. */ u32 header_version; |
9ace3fc81 image: add suppor... |
53 |
|
0b6febfdb Update include/an... |
54 55 56 57 58 |
/* Operating system version and security patch level. * For version "A.B.C" and patch level "Y-M-D": * (7 bits for each of A, B, C; 7 bits for (Y-2000), 4 bits for M) * os_version = A[31:25] B[24:18] C[17:11] (Y-2000)[10:4] M[3:0] */ u32 os_version; |
9ace3fc81 image: add suppor... |
59 |
|
0b6febfdb Update include/an... |
60 |
char name[ANDR_BOOT_NAME_SIZE]; /* asciiz product name */ |
9ace3fc81 image: add suppor... |
61 |
|
0b6febfdb Update include/an... |
62 |
char cmdline[ANDR_BOOT_ARGS_SIZE]; |
210a7176e image: Update inc... |
63 |
|
0b6febfdb Update include/an... |
64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
u32 id[8]; /* timestamp / checksum / sha1 / etc */ /* Supplemental command line data; kept here to maintain * binary compatibility with older versions of mkbootimg. */ char extra_cmdline[ANDR_BOOT_EXTRA_ARGS_SIZE]; /* Fields in boot_img_hdr_v1 and newer. */ u32 recovery_dtbo_size; /* size in bytes for recovery DTBO/ACPIO image */ u64 recovery_dtbo_offset; /* offset to recovery dtbo/acpio in boot image */ u32 header_size; /* Fields in boot_img_hdr_v2 and newer. */ u32 dtb_size; /* size in bytes for DTB image */ u64 dtb_addr; /* physical load address for DTB image */ |
210a7176e image: Update inc... |
78 |
} __attribute__((packed)); |
9ace3fc81 image: add suppor... |
79 |
|
0b6febfdb Update include/an... |
80 81 82 |
/* When a boot header is of version 0, the structure of boot image is as * follows: * |
9ace3fc81 image: add suppor... |
83 84 85 |
* +-----------------+ * | boot header | 1 page * +-----------------+ |
a2018ab0d MLK-18591-3 andro... |
86 |
* | kernel | i pages |
9ace3fc81 image: add suppor... |
87 88 89 |
* +-----------------+ * | ramdisk | m pages * +-----------------+ |
a2018ab0d MLK-18591-3 andro... |
90 91 92 |
* | second stage | n pages * +-----------------+ * | recovery dtbo | o pages |
9ace3fc81 image: add suppor... |
93 94 |
* +-----------------+ * |
a2018ab0d MLK-18591-3 andro... |
95 |
* i = (kernel_size + page_size - 1) / page_size |
9ace3fc81 image: add suppor... |
96 |
* m = (ramdisk_size + page_size - 1) / page_size |
a2018ab0d MLK-18591-3 andro... |
97 98 |
* n = (second_size + page_size - 1) / page_size * o = (recovery_dtbo_size + page_size - 1) / page_size |
9ace3fc81 image: add suppor... |
99 100 101 102 103 104 105 106 107 108 109 110 |
* * 0. all entities are page_size aligned in flash * 1. kernel and ramdisk are required (size != 0) * 2. second is optional (second_size == 0 -> no second) * 3. load each element (kernel, ramdisk, second) at * the specified physical address (kernel_addr, etc) * 4. prepare tags at tag_addr. kernel_args[] is * appended to the kernel commandline in the tags. * 5. r0 = 0, r1 = MACHINE_TYPE, r2 = tags_addr * 6. if second_size != 0: jump to second_addr * else: jump to kernel_addr */ |
0b6febfdb Update include/an... |
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
/* When the boot image header has a version of 2, the structure of the boot * image is as follows: * * +---------------------+ * | boot header | 1 page * +---------------------+ * | kernel | n pages * +---------------------+ * | ramdisk | m pages * +---------------------+ * | second stage | o pages * +---------------------+ * | recovery dtbo/acpio | p pages * +---------------------+ * | dtb | q pages * +---------------------+ |
35e99836c image: android: F... |
128 |
* |
0b6febfdb Update include/an... |
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
* n = (kernel_size + page_size - 1) / page_size * m = (ramdisk_size + page_size - 1) / page_size * o = (second_size + page_size - 1) / page_size * p = (recovery_dtbo_size + page_size - 1) / page_size * q = (dtb_size + page_size - 1) / page_size * * 0. all entities are page_size aligned in flash * 1. kernel, ramdisk and DTB are required (size != 0) * 2. recovery_dtbo/recovery_acpio is required for recovery.img in non-A/B * devices(recovery_dtbo_size != 0) * 3. second is optional (second_size == 0 -> no second) * 4. load each element (kernel, ramdisk, second, dtb) at * the specified physical address (kernel_addr, etc) * 5. If booting to recovery mode in a non-A/B device, extract recovery * dtbo/acpio and apply the correct set of overlays on the base device tree * depending on the hardware/product revision. * 6. prepare tags at tag_addr. kernel_args[] is * appended to the kernel commandline in the tags. * 7. r0 = 0, r1 = MACHINE_TYPE, r2 = tags_addr * 8. if second_size != 0: jump to second_addr * else: jump to kernel_addr */ |
a2018ab0d MLK-18591-3 andro... |
151 152 153 154 155 156 157 158 159 160 161 162 |
struct header_image { uint32_t code0; /* Executable code */ uint32_t code1; /* Executable code */ uint64_t text_offset; /* Image load offset, LE */ uint64_t image_size; /* Effective Image size, LE */ uint64_t res1; /* reserved */ uint64_t res2; /* reserved */ uint64_t res3; /* reserved */ uint64_t res4; /* reserved */ uint32_t magic; /* Magic number */ uint32_t res5; }; |
9ace3fc81 image: add suppor... |
163 |
#endif |