Operation
Image format and boot
On this page
Booting takes two images. The host first loads a small bootloader, boot_xr819.bin; the bootloader then receives the runtime, fw_xr819.bin, unpacks it into the chip’s memories, initializes the PHY and jumps to it.
Bootloader
boot_xr819.bin is a flat binary loaded at 0x0800_0000, its entry point. When it starts it:
- Masks IRQ and FIQ, writes the vendor’s CP15 TCM-region and control words, and copies itself to
0x0901_0000in packet SRAM. The TCM-region writes are in the ARM926 form; they are harmless on the ARM966E-S, whose TCMs are fixed. - Sets its stack to the top of usable DTCM,
0x0400_c000. - Runs the download protocol below and unpacks the runtime.
- Applies the PHY initialization.
- Waits briefly and jumps to the runtime’s entry point.
Download protocol
The bootloader and the host share a control block at 0x0900_ff80 and a 32 KiB FIFO at 0x0900_4000, both in packet SRAM.
| Offset | Address | Register | Type | Description |
|---|---|---|---|---|
+0x00 |
0x0900_ff80 |
IMAGE_SIZE |
u32 | The loader writes 0x1234_5678 (“I am here”); the host answers with the image size in bytes. |
+0x04 |
0x0900_ff84 |
FLAGS |
u32 | Cleared by the loader. |
+0x08 |
0x0900_ff88 |
PUT |
u32 | Host: bytes written into the FIFO so far. |
+0x0c |
0x0900_ff8c |
TRACE_PC |
u32 | Loader: progress, for debugging. |
+0x10 |
0x0900_ff90 |
GET |
u32 | Loader: bytes consumed from the FIFO so far. |
+0x14 |
0x0900_ff94 |
STATUS |
u32 | Pending, then the final result; see the status table. |
+0x18 |
0x0900_ff98 |
DEBUG |
26 × u32 | Loader debug words; +0x18 holds the last word read. |
Source: download::Control · 128 bytes
- The bootloader clears
FLAGS,PUTandGET, setsSTATUSto0xffff_ffff(pending) and writes0x1234_5678(“I am here”) toIMAGE_SIZE. - The host writes the image size in bytes to
IMAGE_SIZE. The bootloader waits for any value other than its own0x1234_5678and the host’s0x8765_4321(“are you here”) probe. - The host copies the image into the FIFO and advances
PUT. The bootloader reads 32-bit words and advancesGET. - The bootloader writes the final
STATUS.
PUT and GET are cumulative byte counts from the start of the image; they do not wrap. Only the FIFO position wraps: byte n of the image is at 0x0900_4000 + (n mod 0x8000). The host must not let PUT run more than 0x8000 bytes ahead of GET.
STATUS |
Meaning |
|---|---|
0xffff_ffff |
Loading. Also what remains if a record runs past the announced size: the bootloader stops without a final status. |
| 0 | The container was accepted and unpacked. The bootloader then applies the PHY initialization and jumps; success does not mean the runtime is up. The runtime’s startup indication says that. |
| 5 | Bad size: not a multiple of 4, or outside 16 bytes to 1 MiB |
| 6 | Bad content: magic word, record type, destination or entry point |
Container format
The runtime image is an XR01 container: a sequence of records that the bootloader applies in order. All fields are little-endian 32-bit words; lengths are in bytes and must be multiples of 4.
magic "XR01"
copy 0, destination, length, data[length]
fill 1, destination, value, length
MMIO 2, byte_length, (address, value)[byte_length / 8]
entry 4, entry_address, trailer
No record of type 3 is known.
The open bootloader accepts only copy, fill and entry records. A fill’s value must be 0, and every destination must be 4-byte aligned and lie entirely inside one of these windows; anything else sets STATUS to 6 before any jump:
| Window | Range |
|---|---|
| ITCM | 0x0000_0000–0x0001_ffff |
| DTCM, below the stacks | 0x0400_0000–0x0400_9fff |
| High SRAM | 0xfff0_0000–0xfff1_3fff |
The entry record must end the stream exactly, and its entry point, ignoring bit 0, must lie in ITCM or high SRAM. The bootloader jumps to the address as given, so bit 0 set enters the runtime in Thumb state. Its trailer word is ignored: the vendor’s trailer is not a CRC32 of the stream or of the payloads, and remains opaque.
Building a container
cargo xtask image turns the runtime ELF’s loadable segments into records: a copy for each segment’s bytes, with zero runs of 64 bytes or more and the zero-initialized tail emitted as fill records, then one entry record. Nothing may load into packet SRAM, and DTCM loads must stay below the stacks.
Do not convert the ELF with objcopy -O binary. ITCM, DTCM and high SRAM are far apart, and a flat image would fill the gaps between them.
Vendor container
For reference, the vendor’s fw_xr819.bin (130,628 bytes, SHA-256 3e2462d476c9dfcb907cda1ba81d0a6d1bbee5e3207bdc1911ec5042d96fdfca) holds these records:
| # | Kind | File offset | Destination | Length | Contents |
|---|---|---|---|---|---|
| 0 | copy | 0x00004 |
0xfff0_0000 |
0x1a7c |
High bootstrap and support routines, ARM |
| 1 | fill | 0x01a8c |
0xfff0_1a7c |
0x1d24 |
Zero |
| 2 | fill | 0x01a9c |
0xfff0_37a0 |
0x1_0860 |
Zero, up to 0xfff1_4000 |
| 3 | copy | 0x01aac |
0x0000_0000 |
0x1_b3d0 |
Main image, Thumb, ITCM |
| 4 | copy | 0x1ce88 |
0x0400_0000 |
0x10f8 |
Initialized DTCM |
| 5 | copy | 0x1df8c |
0x0400_10f8 |
0x0f80 |
Initialized DTCM |
| 6 | fill | 0x1ef18 |
0x0400_2078 |
0x7bcc |
Zero, up to 0x0400_9c44 |
| 7 | MMIO | 0x1ef28 |
— | 0x148 |
41 register writes |
| 8 | copy | 0x1f078 |
0x0ab8_1000 |
0x400 |
PHY table |
| 9 | copy | 0x1f484 |
0x0ab8_8400 |
0x330 |
PHY table |
| 10 | copy | 0x1f7c0 |
0x0ab8_8800 |
0x330 |
PHY table |
| 11 | copy | 0x1fafc |
0x0ab8_8c00 |
0x330 |
PHY table |
| 12 | entry | 0x1fe38 |
0xfff0_0000 |
— | Trailer 0x3994_defa |
PHY initialization
Records 7 to 11 initialize the PHY. They belong to image loading, not to the runtime, so the open bootloader applies them itself after unpacking the runtime and before jumping to it. PHY and RF lists them.