summaryrefslogtreecommitdiff
path: root/include/android_image.h (plain)
blob: d18709565f8ec1ca009cda2a054c25db640f4ec5
1/*
2 * This is from the Android Project,
3 * Repository: https://android.googlesource.com/platform/bootable/bootloader/legacy
4 * File: include/boot/bootimg.h
5 * Commit: 4205b865141ff2e255fe1d3bd16de18e217ef06a
6 *
7 * Copyright (C) 2008 The Android Open Source Project
8 *
9 * SPDX-License-Identifier: BSD-2-Clause
10 */
11
12#ifndef _ANDROID_IMAGE_H_
13#define _ANDROID_IMAGE_H_
14
15#define ANDR_BOOT_MAGIC "ANDROID!"
16#define ANDR_BOOT_MAGIC_SIZE 8
17#define ANDR_BOOT_NAME_SIZE 16
18#define ANDR_BOOT_ARGS_SIZE 512
19
20struct andr_img_hdr {
21 char magic[ANDR_BOOT_MAGIC_SIZE];
22
23 u32 kernel_size; /* size in bytes */
24 u32 kernel_addr; /* physical load addr */
25
26 u32 ramdisk_size; /* size in bytes */
27 u32 ramdisk_addr; /* physical load addr */
28
29 u32 second_size; /* size in bytes */
30 u32 second_addr; /* physical load addr */
31
32 u32 tags_addr; /* physical addr for kernel tags */
33 u32 page_size; /* flash page size we assume */
34
35 u32 kernel_version; /* highest byte: 1 = boot, 2 = recovery;
36 low three bytes: kernel version */
37
38 /* operating system version and security patch level; for
39 * version "A.B.C" and patch level "Y-M-D":
40 * ver = A << 14 | B << 7 | C (7 bits for each of A, B, C)
41 * lvl = ((Y - 2000) & 127) << 4 | M (7 bits for Y, 4 bits for M)
42 * os_version = ver << 11 | lvl */
43 uint32_t os_version;
44
45 char name[ANDR_BOOT_NAME_SIZE]; /* asciiz product name */
46
47 char cmdline[ANDR_BOOT_ARGS_SIZE];
48
49 u32 id[8]; /* timestamp / checksum / sha1 / etc */
50};
51
52/*
53 * +-----------------+
54 * | boot header | 1 page
55 * +-----------------+
56 * | kernel | n pages
57 * +-----------------+
58 * | ramdisk | m pages
59 * +-----------------+
60 * | second stage | o pages
61 * +-----------------+
62 *
63 * n = (kernel_size + page_size - 1) / page_size
64 * m = (ramdisk_size + page_size - 1) / page_size
65 * o = (second_size + page_size - 1) / page_size
66 *
67 * 0. all entities are page_size aligned in flash
68 * 1. kernel and ramdisk are required (size != 0)
69 * 2. second is optional (second_size == 0 -> no second)
70 * 3. load each element (kernel, ramdisk, second) at
71 * the specified physical address (kernel_addr, etc)
72 * 4. prepare tags at tag_addr. kernel_args[] is
73 * appended to the kernel commandline in the tags.
74 * 5. r0 = 0, r1 = MACHINE_TYPE, r2 = tags_addr
75 * 6. if second_size != 0: jump to second_addr
76 * else: jump to kernel_addr
77 */
78#endif
79