aboutsummaryrefslogtreecommitdiff
path: root/CHANGELOG.md
AgeCommit message (Collapse)Author
6 hoursPrototype secondary core supportHEADmainIan McIntyre
Haven't tested the included examples on hardware. It's just here so I can define an inspect_elf test. Out of tree, there's a basic example on an 1170EVK.
2026-10-27Align all sections to 8 bytes minimumIan McIntyre
8 byte alignment means we can perform per-section ECC RAM preloading, usually requiring 64-bit accesses.
2026-03-08Preload RAM for ECC ciphersIan McIntyre
Testing shows that we must blow fuses in order to activate either ECC engine. Once the fuse is blown, NXP's boot ROM will enable the ECC engine. So by the time the reset handler is running, ECC may already be enabled. The 32-bit copy loops won't work for initializing ITCM and OCRAM. Since these bus widths are 64-bit and the ECC is computed over 64 bits, these 32 bit accesses result in a read-modify-write (RMW) on the underlying interface. If these RAM regions aren't already initialized, we'll fail an ECC check; the read in RMW compares bogus RAM contents against a bogus ECC. This seems to dramatically slow down initialization, or stall it (I've seen the CPU spinning in the boot ROM). If we listen to NXP and use 64-bit writes to preload ECC-protected RAM regions, the 32-bit copy loops will work as expected. Note that we can still issue 64-bit accesses towards DTCM; they're scattered across the two 32-bit interfaces. There's an NXP whitepaper [1] describing that. Once TCM ECC is enabled, we need to tell the TCM interfaces to RMW smaller accesses. Otherwise, we won't generate correct ciphers. We also might need to retry operations if there was a correction by the RAM controller. We can perform these with predicated instructions. Tested on an 1010EVK, where I used the debugger to show the control registers weren't touched; and tested on the 1170EVK, with the same approach showing the expected set bits. [1]: https://www.nxp.com/docs/en/white-paper/CORTEXM7WP.pdf [2]: https://www.nxp.com/docs/en/application-note/AN13204.pdf
2026-03-08Restrict RAM if ECC is enabledIan McIntyre
As of this commit, the RuntimeBuilder only limits the available OCRAM if either ECC controller is enabled. It's misleading; however, it gives users a chance to evaluate their firmware builds with the restricted RAM regions. I'll add and test the controller setups in a later commit. Existing tests still pass. New unit tests demonstrate the restricted RAM behavior.
2026-03-08Add section for boot ROM reservationsIan McIntyre
The boot ROM is allowed to use allocations of OCRAM as scratch space. If you interact with the boot ROM -- using it to interact with FlexSPI, for instance -- then you cannot also use these OCRAM regions. See the system boot chapter in the reference manual for more info. The boot ROM typically reserves the start of OCRAM. The size varies by chip. This commit describes a new section, .bootrom_reservation, at the start of OCRAM. Users are encouraged to place a MaybeUninit buffer that's sized for your ROM's requirements. If users don't place anything in this section, then the new directive is a no-op. On the other hand, the section is defined before other RAM regions, so that it takes precedence over other sections users might want to place in OCRAM. Tested using the runtime's test suite. I'm testing with the Teensy 4 binary, since the test suite can support features in this build. The updated test suite shows that the linker will place the boot ROM reservation before placing the stack, suggesting that we're respecting section priority.
2026-02-19Relax cortex-m-rt version specificationRock Boynton
cortex-m-rt v0.7.3 and earlier didn't document support for custom linker scripts. Without that, I figured we were relying on an implementation detail, and a patch version bump could break dependents. Pinning the version avoided that possibility. Now that there's documented support for custom scripts, we can relax that.
2026-02-15Add builder config for boot_header inclusionIan McIntyre
To form a secondary image, use in_flash to position it in flash, then override the default setting that disables the boot header. With proper configuration, NXP's boot ROM can load a backup image. This commit reconfigures the 1170EVK board for the experiment.
2025-11-26Let users change name of included device.x fileIan McIntyre
Alternate PAC designs might describe the device file with a custom / chip specific name. This change lets users specify which linker script they're using.
2025-11-22Add builder API for FlexRAM bank layoutIan McIntyre
The layout, or assignment of FlexRAM banks to memory regions, is more precise than the count. When a user specifies the count, we still apply the same layout as we always have. But now, by default, we prefer the fuse layout for users who have made no choice. This commit supports RAM loading with probe-rs. After probe-rs resets the MCU and uses the fuse FlexRAM layout, firmware can perfectly match that layout without disrupting the data already copied into RAM by the debugger.
2025-09-09Reserve address 0 by shifting ITCM start addressIan McIntyre
The runtime previously allowed function placement at address 0 in ITCM. However, if you ever formed a pointer to the function placed there, it would look like a null pointer. And you would never be able to call that function if you relied on null pointer optimization. Also, most MCU reference manuals (RM) recommend against this placement. This commit reduces the total capacity of ITCM by 32 bytes, the smallest possible size of a MPU region. Note that this is greater than the RM's recommendation of a four byte reservation. It affects all supported MCUs, except the 1180. If you're so inclined, your MPU could disallow loads, stores, and execution from this reservation. Revised unit tests should cover this change. Additionally, you can manually verify that the ITCM region lengths are reduced by 32 bytes by opening the linker scripts generated by the ELF test suite.
2025-06-13Prepare 0.1.7 releaseIan McIntyre
2025-03-21Added in_flash RuntimeBuilder constructorSherif A Abdou
Applications linked through this builder can be placed in a flash reservation. You'll need some other software to launch these programs, since they lack the boot header required by the NXP boot ROM.
2025-03-13Place .xip sections into flashIan McIntyre
We added the `.xip` section to ensure that the reset handler and pre-init functions would be placed in flash. This commit lets users place other content into that section. `.xip` is intended for instructions. The runtime builder will place these instructions into the same load region as `.text`. However, there's no pre-`main` relocation. Aligning the `.xip` and the `.text` section produces more predictable behavior between GNU's ld and LLVM's lld.
2025-03-01Prepare 0.1.6 releaseIan McIntyre
2025-02-22Document workaround for registering exceptionsIan McIntyre
Given the way this package abuses cortex-m-rt, it's not immediately obvious how to register a Cortex-M exception handler with the `#[exception]` macro. This commit documents and demonstrates the workaround I use.
2025-02-08Add imxrt1160 target supportIan McIntyre
Implemented by following the reference manual, and tested on an MIMXRT1160EVK. The target adopts all of the same limitations as the 1170 target.
2025-01-04Add imxrt1040 target supportIan McIntyre
I derived these values from the reference manual. Tested on an MIMXRT1040EVK.
2024-10-26Prepare 0.1.5 releaseIan McIntyre
2024-10-17Support RT1180 familyNils Fitinghoff
The 1180 family uses a different boot header than previous families. The header is generated to support the default configuration where hash and signature errors are ignored. The XIP `__pre_init` strategy is still used, more for ease of getting something running than because of any known problems with the boot ROM's implementation of loading images to different memories. The boot ROM for the 1180 does not appear to allow the entry point to lie outside the (loaded or execute-in-place) image, so a new `.xip` section is added after the vector table to put the address inside the image while keeping VMA=LMA. This could cause problems for tools that manipulate binaries based on section names.
2024-04-05Prepare 0.1.4 releaseIan McIntyre
2024-04-03Add environment variable overrides for stack, heapIan McIntyre
If you define a runtime, you can call `stack_size_env_override` to define an optional environment variable checked by the runtime builder. Same goes for the heap. A user can set these environment variables to override the runtime's stack / heap size. You can use this package's examples to try it out; see the updated build script. There's no default environment variable for either memory region. The package that defines the runtime needs to opt-in to this feature.
2023-10-01Prepare 0.1.3 releaseIan McIntyre
2023-09-08Prepare 0.1.2 releaseIan McIntyre
2023-09-08Add optional DCD section in linker scriptsummivox
Users can define their device configuration data (DCD), and place the data in the .dcd section. If the .dcd section has content, the entry in the IVT points at the user's DCD. This plays well with imxrt-dcd.
2023-02-14Prepare 0.1.1 releaseIan McIntyre
2022-12-02Fix tag URLs in CHANGELOGIan McIntyre
2022-12-02Add CHANGELOG for release trackingIan McIntyre