# Changelog

## [Unreleased]

Establish a 32 byte reservation at the start of ITCM where instructions are
never placed. This reduces the total capacity of ITCM by 32 bytes on nearly
all MCUs, except the 1180.

Provide a `RuntimeBuilder::device_script_name` method to change the name of
the device linker script that's included in the runtime. By default, the name
remains `device.x`. The name only matters if the "device" crate feature is
enabled.

### FlexRAM bank layouts

The runtime builder lets users specify the _layout_, or assignment, of FlexRAM
banks. This is more precise than the _count_ of banks.

By default, the layout remains an implementation detail of the builder. This is
true if you only specify the count, or if you make no choice. However, if you
specify the layout, the builder guarantees that the FlexRAM banks will match
that layout.

### cortex-m-rt 0.7.5

Update to cortex-m-rt 0.7.5. The new runtime introduces additional build-time
features. You could enable these features yourself by depending on the same
`cortex-m-rt` package and selecting features. Here's how this runtime supports
each `cortex-m-rt` feature.

The `paint-stack` feature is not supported. Do not enable this feature.
(Upstream commits suggest that we should be able to support stack painting in a
future release.)

The `zero-init-ram` feature will zero the VMA region of `.data` before copying
contents from the load region. This isn't particularly useful, but it's safe to
enable.

This package still enables `set-vtor` and `set-sp` features by default. For
convenience, this package still forwards the `device` feature.

## [0.1.7] 2025-06-14

Introduce `RuntimeBuilder::in_flash` for creating images that can be launched
by your own software, instead of NXP's boot ROM.

Place sections starting with `.xip` into the same load region of `.text`.
Unlike `.text`, the contents in `.xip` will not be relocated.

Four byte align both the `.xip` and `.text` sections for more predictable
behaviors across linkers.

## [0.1.6] 2025-03-01

Add new MCU targets:

- imxrt1040
- imxrt1160

Document workaround for registering exception handlers.

## [0.1.5] 2024-10-26

Add initial support for RT1180.

## [0.1.4] 2024-04-05

Add configurations to `RuntimeBuilder`:

- `stack_size_env_override`
- `heap_size_env_override`

Use these methods to define environment variables that can override the
stack / heap sizes.

## [0.1.3] 2023-10-01

Ensure that the runtime supports the GNU linker, `ld`.

## [0.1.2] 2023-09-08

Add section for device configuration data (DCD) in linker script. Users
can place their DCD in a section called `.dcd`. Consider using imxrt-dcd
as a convenient way to define a DCD.

## [0.1.1] 2023-02-14

Update to cortex-m-rt 0.7.3 to avoid certain miscompilation opportunities.
For more information, see the [cortex-m-rt advisory][cmrt-0.7.3].

[cmrt-0.7.3]: https://github.com/rust-embedded/cortex-m/discussions/469

Note that imxrt-rt 0.1.0 will no longer build. If you observe this error,
ensure that your build uses this imxrt-rt release.

## [0.1.0] 2022-12-02

First release. `imxrt-rt` provides a build-time API that defines a memory map,
as well as a runtime library that configures i.MX RT 10xx and 11xx processors.

[Unreleased]: https://github.com/imxrt-rs/imxrt-rt/compare/v0.1.6...HEAD
[0.1.7]: https://github.com/imxrt-rs/imxrt-rt/releases/compare/v0.1.6...v0.1.7
[0.1.6]: https://github.com/imxrt-rs/imxrt-rt/releases/compare/v0.1.5...v0.1.6
[0.1.5]: https://github.com/imxrt-rs/imxrt-rt/releases/compare/v0.1.4...v0.1.5
[0.1.4]: https://github.com/imxrt-rs/imxrt-rt/releases/compare/v0.1.3...v0.1.4
[0.1.3]: https://github.com/imxrt-rs/imxrt-rt/releases/compare/v0.1.2...v0.1.3
[0.1.2]: https://github.com/imxrt-rs/imxrt-rt/releases/compare/v0.1.1...v0.1.2
[0.1.1]: https://github.com/imxrt-rs/imxrt-rt/releases/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/imxrt-rs/imxrt-rt/releases/tag/v0.1.0