|
| 1 | +#!/usr/bin/env python3 |
| 2 | +# lpc54s0xx_patch_boot_block.py |
| 3 | +# |
| 4 | +# Patch a wolfBoot binary for the NXP LPC540xx / LPC54S0xx SPIFI (XIP) boot |
| 5 | +# ROM. The ROM expects an "enhanced boot block": |
| 6 | +# - offset 0x1C: vector table checksum (negated sum of the first 7 words) |
| 7 | +# - offset 0x24: boot block marker + offset to descriptor |
| 8 | +# - offset 0x160: 25-word descriptor (magic, mode, image base, image size, ...) |
| 9 | +# |
| 10 | +# Usage: lpc54s0xx_patch_boot_block.py <wolfboot.bin> |
| 11 | +# |
| 12 | +# Copyright (C) 2025 wolfSSL Inc. |
| 13 | +# This file is part of wolfBoot (GPL-2.0-or-later). |
| 14 | + |
| 15 | +import os |
| 16 | +import struct |
| 17 | +import sys |
| 18 | + |
| 19 | +HEADER_MARKER_OFFSET = 0x24 |
| 20 | +BOOT_BLOCK_OFFSET = 0x160 |
| 21 | +VECTOR_CHECKSUM_OFFSET = 0x1C |
| 22 | +IMAGE_BASE_ADDR = 0x10000000 # SPIFI XIP base |
| 23 | + |
| 24 | +HEADER_MARKER_FMT = "<2I" # 0xEDDC94BD, 0x160 |
| 25 | +BOOT_BLOCK_FMT = "<25I" |
| 26 | +VECTOR_TABLE_FMT = "<7I" # first 7 words covered by checksum |
| 27 | + |
| 28 | + |
| 29 | +def patch(path): |
| 30 | + size = os.path.getsize(path) |
| 31 | + header_marker_size = struct.calcsize(HEADER_MARKER_FMT) |
| 32 | + boot_block_size = struct.calcsize(BOOT_BLOCK_FMT) |
| 33 | + vector_table_size = struct.calcsize(VECTOR_TABLE_FMT) |
| 34 | + |
| 35 | + min_size = max( |
| 36 | + vector_table_size, |
| 37 | + HEADER_MARKER_OFFSET + header_marker_size, |
| 38 | + BOOT_BLOCK_OFFSET + boot_block_size, |
| 39 | + ) |
| 40 | + if size < min_size: |
| 41 | + raise SystemExit( |
| 42 | + "error: %s is too small for LPC54S0xx boot block patching " |
| 43 | + "(size=%d, need at least %d bytes)" % (path, size, min_size) |
| 44 | + ) |
| 45 | + |
| 46 | + with open(path, "r+b") as f: |
| 47 | + f.seek(HEADER_MARKER_OFFSET) |
| 48 | + f.write(struct.pack(HEADER_MARKER_FMT, 0xEDDC94BD, BOOT_BLOCK_OFFSET)) |
| 49 | + |
| 50 | + f.seek(BOOT_BLOCK_OFFSET) |
| 51 | + f.write(struct.pack( |
| 52 | + BOOT_BLOCK_FMT, |
| 53 | + 0xFEEDA5A5, # magic |
| 54 | + 3, # image type |
| 55 | + IMAGE_BASE_ADDR, # image base |
| 56 | + size - 4, # image size (minus CRC slot) |
| 57 | + 0, 0, 0, 0, 0, |
| 58 | + 0xEDDC94BD, # header marker echo |
| 59 | + 0, 0, 0, |
| 60 | + 0x001640EF, # SPIFI config |
| 61 | + 0, 0, |
| 62 | + 0x1301001D, # clock/flash timing word |
| 63 | + 0, 0, 0, |
| 64 | + 0x00000100, # options |
| 65 | + 0, 0, |
| 66 | + 0x04030050, # PLL config |
| 67 | + 0x14110D09, # clock divider config |
| 68 | + )) |
| 69 | + |
| 70 | + f.seek(0) |
| 71 | + words = struct.unpack(VECTOR_TABLE_FMT, f.read(vector_table_size)) |
| 72 | + checksum = (0x100000000 - (sum(words) & 0xFFFFFFFF)) & 0xFFFFFFFF |
| 73 | + f.seek(VECTOR_CHECKSUM_OFFSET) |
| 74 | + f.write(struct.pack("<I", checksum)) |
| 75 | + |
| 76 | + print("\tvector checksum: 0x%08X" % checksum) |
| 77 | + |
| 78 | + |
| 79 | +def main(argv): |
| 80 | + if len(argv) != 2: |
| 81 | + raise SystemExit("usage: %s <wolfboot.bin>" % argv[0]) |
| 82 | + patch(argv[1]) |
| 83 | + |
| 84 | + |
| 85 | +if __name__ == "__main__": |
| 86 | + main(sys.argv) |
0 commit comments