ptgen: add Chromium OS kernel partition support
[project/firmware-utils.git] / src / bcm_tag.h
1 // SPDX-License-Identifier: GPL-2.0-only
2 #ifndef __BCM63XX_TAG_H
3 #define __BCM63XX_TAG_H
4
5 #define TAGVER_LEN 4 /* Length of Tag Version */
6 #define TAGLAYOUT_LEN 4 /* Length of FlashLayoutVer */
7 #define SIG1_LEN 20 /* Company Signature 1 Length */
8 #define SIG2_LEN 14 /* Company Signature 2 Lenght */
9 #define BOARDID_LEN 16 /* Length of BoardId */
10 #define ENDIANFLAG_LEN 2 /* Endian Flag Length */
11 #define CHIPID_LEN 6 /* Chip Id Length */
12 #define IMAGE_LEN 10 /* Length of Length Field */
13 #define ADDRESS_LEN 12 /* Length of Address field */
14 #define DUALFLAG_LEN 2 /* Dual Image flag Length */
15 #define INACTIVEFLAG_LEN 2 /* Inactie Flag Length */
16 #define RSASIG_LEN 20 /* Length of RSA Signature in tag */
17 #define TAGINFO1_LEN 30 /* Length of vendor information field1 in tag */
18 #define FLASHLAYOUTVER_LEN 4 /* Length of Flash Layout Version String tag */
19 #define TAGINFO2_LEN 16 /* Length of vendor information field2 in tag */
20 #define CRC_LEN 4 /* Length of CRC in bytes */
21 #define ALTTAGINFO_LEN 54 /* Alternate length for vendor information; Pirelli */
22
23 #define NUM_PIRELLI 2
24 #define IMAGETAG_CRC_START 0xFFFFFFFF
25
26 #define PIRELLI_BOARDS { \
27 "AGPF-S0", \
28 "DWV-S0", \
29 }
30
31 /*
32 * The broadcom firmware assumes the rootfs starts the image,
33 * therefore uses the rootfs start (flashImageAddress)
34 * to determine where to flash the image. Since we have the kernel first
35 * we have to give it the kernel address, but the crc uses the length
36 * associated with this address (rootLength), which is added to the kernel
37 * length (kernelLength) to determine the length of image to flash and thus
38 * needs to be rootfs + deadcode (jffs2 EOF marker)
39 */
40
41 struct bcm_tag {
42 char tagVersion[TAGVER_LEN]; // 0-3: Version of the image tag
43 char sig_1[SIG1_LEN]; // 4-23: Company Line 1
44 char sig_2[SIG2_LEN]; // 24-37: Company Line 2
45 char chipid[CHIPID_LEN]; // 38-43: Chip this image is for
46 char boardid[BOARDID_LEN]; // 44-59: Board name
47 char big_endian[ENDIANFLAG_LEN]; // 60-61: Map endianness -- 1 BE 0 LE
48 char totalLength[IMAGE_LEN]; // 62-71: Total length of image
49 char cfeAddress[ADDRESS_LEN]; // 72-83: Address in memory of CFE
50 char cfeLength[IMAGE_LEN]; // 84-93: Size of CFE
51 char flashImageStart[ADDRESS_LEN]; // 94-105: Address in memory of image start (kernel for OpenWRT, rootfs for stock firmware)
52 char flashRootLength[IMAGE_LEN]; // 106-115: Size of rootfs for flashing
53 char kernelAddress[ADDRESS_LEN]; // 116-127: Address in memory of kernel
54 char kernelLength[IMAGE_LEN]; // 128-137: Size of kernel
55 char dualImage[DUALFLAG_LEN]; // 138-139: Unused at present
56 char inactiveFlag[INACTIVEFLAG_LEN]; // 140-141: Unused at present
57 char rsa_signature[RSASIG_LEN]; // 142-161: RSA Signature (unused at present; some vendors may use this)
58 char information1[TAGINFO1_LEN]; // 162-191: Compilation and related information (not generated/used by OpenWRT)
59 char flashLayoutVer[FLASHLAYOUTVER_LEN];// 192-195: Version flash layout
60 char fskernelCRC[CRC_LEN]; // 196-199: kernel+rootfs CRC32
61 char information2[TAGINFO2_LEN]; // 200-215: Unused at present except Alice Gate where is is information
62 char imageCRC[CRC_LEN]; // 216-219: CRC32 of image less imagetag (kernel for Alice Gate)
63 char rootfsCRC[CRC_LEN]; // 220-223: CRC32 of rootfs partition
64 char kernelCRC[CRC_LEN]; // 224-227: CRC32 of kernel partition
65 char imageSequence[4]; // 228-231: Image sequence number
66 char rootLength[4]; // 232-235: steal from reserved1 to keep the real root length so we can use in the flash map even after we have change the rootLength to 0 to satisfy devices that check CRC on every boot
67 char headerCRC[CRC_LEN]; // 236-239: CRC32 of header excluding tagVersion
68 char reserved2[16]; // 240-255: Unused at present
69 };
70
71 #endif /* __BCM63XX_TAG_H */