rtic/rtic-monotonics/CHANGELOG.md

# Change Log

All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

For each category, *Added*, *Changed*, *Fixed* add new entries at the top!

## Unreleased

## v2.0.0 - 2024-05-29

### Changed

- Rework all timers based on `rtic-time 2.0.0`
- Most timer tick rates are now configurable
- Tweak `build.rs` to avoid warnings in Nightly 1.78+
- Removed unused `rust-toolchain.toml`
- RP2040 PAC 0.6 support

## v1.5.0 - 2024-01-10

### Changed

- Using `embedded-hal` 1.0.

## v1.4.1 - 2023-12-06

### Fixed

- Fix race condition in `nrf::timer`.
- Fix race condition in `nrf::rtc`.
- Fix errata in `nrf::rtc`.
- Add internal counter integrity check to all half-period based monotonics.
- Apply race condition fixes from `rtic-time`.

## v1.4.0 - 2023-12-04

### Fixed

- **Soundness fix:** Monotonics did not wait long enough in `Duration` based delays.

### Changed

- Bump `rtic-time`

## v1.3.0 - 2023-11-08

### Added

- i.MX RT support

### Fixed

- Fix STM32 rollover race condition
- Fix STM32 support for other chip families

## v1.2.0 - 2023-09-19

### Added

- STM32 support.
- `embedded-hal` 1.0.0-rc.1 `DelayUs` support

## v1.1.0 - 2023-08-29

### Added

- Feature `systick-64bit` to get 64-bit backed `TimerInstantU64` instead of `TimerInstantU32` from the SysTick-based monotonic timer

## v1.0.1 - 2023-08-20

### Added

- RP2040 PAC 0.5 support
- nRF52xxx, nRF9160, nRF5340 Timer and RTC monotonics
- Interrupt tokens for `Systick` and `rp2040` to make sure an interrupt handler exists

### Changed

- Bump `embedded-hal-async`

### Fixed

- Unmask the `rp2040` interrupt
- Use `$crate` and fully qualified paths in macros

## v1.0.0 - 2023-05-31
Add changelog templates 2023-01-28 11:15:59 +01:00			`# Change Log`

			`All notable changes to this project will be documented in this file.`
			`This project adheres to [Semantic Versioning](http://semver.org/).`

			`For each category, Added, Changed, Fixed add new entries at the top!`

Cleanup CHANGELOGs for monotonics/time v2 release 2024-05-29 21:01:51 +02:00			`## Unreleased`

			`## v2.0.0 - 2024-05-29`
Bump embedded-hal-async in rtic-monotonics 2023-08-20 13:00:33 +02:00
Make RTIC 2 work on stable by using `main`'s stack as an allocator 2024-01-29 20:56:15 +01:00			`### Changed`

Monotonic rewrite (#874) * Rework timer_queue and monotonic architecture Goals: * make Monotonic purely internal * make Monotonic purely tick passed, no fugit involved * create a wrapper struct in the user's code via a macro that then converts the "now" from the tick based monotonic to a fugit based timestamp We need to proxy the delay functions of the timer queue anyway, so we could simply perform the conversion in those proxy functions. * Update cargo.lock * Update readme of rtic-time * CI: ESP32: Redact esp_image: Too volatile * Fixup: Changelog double entry rebase mistake --------- Co-authored-by: Henrik Tjäder <henrik@tjaders.com> 2024-04-11 00:00:38 +02:00			- Rework all timers based on `rtic-time 2.0.0`
			`- Most timer tick rates are now configurable`
RISC-V support over CLINT (#815) * Rebase to master * using interrupt_mod * bug fixes * fix other backends * Add changelog * forgot about rtic-macros * backend-specific configuration * core peripherals optional over macro argument * pre_init_preprocessing binding * CI for RISC-V (WIP) * separation of concerns * add targets for RISC-V examples * remove qemu feature * prepare examples folder * move examples all together * move ci out of examples * minor changes * add cortex-m * new xtask: proof of concept * fix build.yml * feature typo * clean rtic examples * reproduce weird issue * remove unsafe code in user app * update dependencies * allow builds on riscv32imc * let's fix QEMU * Update .github/workflows/build.yml Co-authored-by: Henrik Tjäder <henrik@tjaders.com> * New build.rs * removing test features * adapt ui test to new version of clippy * add more examples to RISC-V backend * proper configuration of heapless for riscv32imc * opt-out examples for riscv32imc * point to new version of riscv-slic * adapt new macro bindings * adapt examples and CI to stable * fix cortex-m CI * Review --------- Co-authored-by: Henrik Tjäder <henrik@tjaders.com> 2024-03-20 21:06:47 +01:00			- Tweak `build.rs` to avoid warnings in Nightly 1.78+
Make RTIC 2 work on stable by using `main`'s stack as an allocator 2024-01-29 20:56:15 +01:00			- Removed unused `rust-toolchain.toml`
Bump rp2040-pac to 0.6 in rtic-monotonics (#905) * Support rp2040-pac v0.6 in rtic-monotonics * Add changelog entry * Fix rp2040_local_i2c_init example 2024-04-21 12:46:29 +02:00			`- RP2040 PAC 0.6 support`
Make RTIC 2 work on stable by using `main`'s stack as an allocator 2024-01-29 20:56:15 +01:00
Upgrade everything to embedded-hal v1.0.0 (#880) 2024-01-10 20:21:38 +01:00			`## v1.5.0 - 2024-01-10`

update to embedded-hal 1 (#879) * update to eh1 * changelogs about embedded-hal 1.0 2024-01-10 20:15:07 +01:00			`### Changed`

			- Using `embedded-hal` 1.0.

Prepare release of rtic-monotonics 1.4.1 and rtic-time 1.2.0 (#861) 2023-12-06 19:44:35 +01:00			`## v1.4.1 - 2023-12-06`

Fix nrf monotonics (#852) * Fix nrf::timer * Bootstrap nrf52840-blinky example * More work on nrf blinky example * Fix README * Add asserts for correct timer functionality * Add correctness check to other monotonics as well * Update Changelog * Fix potential timing issues * Fix race condition in nrf::rtc * Add changelog * Add rtc blinky example * Change rtc example to RC lf clock source * Add changelog to rtic-time * Add changelog * Attempt to fix CI * Update teensy4-blinky Cargo.lock 2023-12-06 08:49:38 +01:00			`### Fixed`

Fix `nrf::rtc` errata workaround (#858) * Deprecate `should_dequeue_check` * Fix errata by delaying the wakeup point * Add changelog * Fix changelog typos 2023-12-06 19:36:06 +01:00			- Fix race condition in `nrf::timer`.
			- Fix race condition in `nrf::rtc`.
			- Fix errata in `nrf::rtc`.
Fix nrf monotonics (#852) * Fix nrf::timer * Bootstrap nrf52840-blinky example * More work on nrf blinky example * Fix README * Add asserts for correct timer functionality * Add correctness check to other monotonics as well * Update Changelog * Fix potential timing issues * Fix race condition in nrf::rtc * Add changelog * Add rtc blinky example * Change rtc example to RC lf clock source * Add changelog to rtic-time * Add changelog * Attempt to fix CI * Update teensy4-blinky Cargo.lock 2023-12-06 08:49:38 +01:00			`- Add internal counter integrity check to all half-period based monotonics.`
Fix race condition in `calculate_now` (#860) * Fix race condition in calculate_now * Add changelog * Update changelog * Refine comment * More comment fixes 2023-12-06 19:36:09 +01:00			- Apply race condition fixes from `rtic-time`.
Fix nrf monotonics (#852) * Fix nrf::timer * Bootstrap nrf52840-blinky example * More work on nrf blinky example * Fix README * Add asserts for correct timer functionality * Add correctness check to other monotonics as well * Update Changelog * Fix potential timing issues * Fix race condition in nrf::rtc * Add changelog * Add rtc blinky example * Change rtc example to RC lf clock source * Add changelog to rtic-time * Add changelog * Attempt to fix CI * Update teensy4-blinky Cargo.lock 2023-12-06 08:49:38 +01:00
Release rtic-monotonics, rtic-sync and rtic-time (#854) 2023-12-04 20:37:00 +01:00			`## v1.4.0 - 2023-12-04`

Fix mono delay (#843) * rtic-time: Compenstate for timer uncertainty * Update changelog and incorrect cargo.lock in an example * Fix Monotonic impls * Fix tests * Fix other monotonics, again * Update changelog * Fix example * Fix DelayUs and DelayMs impls * Minor coding style fix in u64 conversions * Fix all changelogs * Fix changelog * Fix blocking DelayUs * Minor monotonic rework * Add delay precision test * Add more tests * Add rust-version tags to Cargo.toml * Fix imxrt, rp2040 and systick timer * Fix more monotonics * Fix systick monotonic * Some reverts * Fix imxrt * Fix nrf * Fix rp2040 * Fix stm32 * Fix systick * Fix rtic-time tests * Bump to e-h.rc2 * Apply e-h.rc2 fixes to rtic-time * Apply fixes from arbiter * Fix clippy warning * Minor beautification * Revert previous changes * Fix variable name * Add blocking tests, but disable them by default 2023-12-01 08:59:22 +01:00			`### Fixed`

			- Soundness fix: Monotonics did not wait long enough in `Duration` based delays.

Refactor race condition free timer helper (#850) * Implement half_period_counter in rtic-time * Rename compute_now to calculate_now, use it in stm32 and imxrt * Add more tests * Add some docs * Fix clippy warning, add imxrt timer to monotonics tests * Bump dependency version to make sure monotonics will build properly * Add changelog to rtic-monotonics * Add more docs * Add more docs * Finish documentation * Fix typos * Switch from atomic-polyfill to portable-atomic * Some more doc fixes * More doc fixes * Minor doc fix * Minor doc fix * Fix Atomics not existing * Fix example * Minor example improvement * Revert back to atomic-polyfill * Fix cargo.toml formatting * Remove atomic-polyfill * Attempt to fix unused macro warning * Remove atomics completely from half period counter * Minor doc fix * Doc fixes * Doc fixes * Remove obsolete comment * Fix ordering in monotonic initialization sequence 2023-12-04 15:53:02 +01:00			`### Changed`

			- Bump `rtic-time`

Prepare rtic-monotonics v1.3.0 release 2023-11-08 20:45:57 +01:00			`## v1.3.0 - 2023-11-08`

Add Monotonic for i.MX RT chip family 2023-11-01 12:13:25 +01:00			`### Added`

			`- i.MX RT support`

rtic-monotonics: Fix stm32-metapac use Previously, the stm32 monotonics only compiled for some chip families. For example, stm32g081kb worked, but not stm32f407*. The stm32-metapac does not directly unify peripheral names between the many stm32 families, but provides tools for build scripts to generate code that uses the right names for the selected chip. Use that mechanism instead of targeting a specific family. 2023-10-02 16:17:39 +02:00			`### Fixed`

Update changelog 2023-11-05 23:57:44 +01:00			`- Fix STM32 rollover race condition`
rtic-monotonics: Fix stm32-metapac use Previously, the stm32 monotonics only compiled for some chip families. For example, stm32g081kb worked, but not stm32f407*. The stm32-metapac does not directly unify peripheral names between the many stm32 families, but provides tools for build scripts to generate code that uses the right names for the selected chip. Use that mechanism instead of targeting a specific family. 2023-10-02 16:17:39 +02:00			`- Fix STM32 support for other chip families`

Release rtic-monotonics v1.2.0 2023-09-19 15:32:19 +02:00			`## v1.2.0 - 2023-09-19`

PoC Monotonic impl based on stm32-metapac 2023-09-03 10:47:33 +02:00			`### Added`

			`- STM32 support.`
rtic-monotonics: Implement blocking DelayUs from embedded-hal 1 2023-09-14 16:47:52 +02:00			- `embedded-hal` 1.0.0-rc.1 `DelayUs` support
PoC Monotonic impl based on stm32-metapac 2023-09-03 10:47:33 +02:00
Release rtic-monotonics 1.1.0, release rtic-sync 1.0.2 2023-08-29 09:14:42 +02:00			`## v1.1.0 - 2023-08-29`

rtic-monotonics: Add 64-bit SysTick monotonic Counting at 1 kHz, 32 bits for counting ticks is not enough to ensure monotonicity for more than 50 days. Add a feature to change the backing storage to 64 bits. 2023-08-24 16:29:20 +02:00			`### Added`

			- Feature `systick-64bit` to get 64-bit backed `TimerInstantU64` instead of `TimerInstantU32` from the SysTick-based monotonic timer

Bump embedded-hal-async in rtic-monotonics 2023-08-20 13:00:33 +02:00			`## v1.0.1 - 2023-08-20`
Add changelog templates 2023-01-28 11:15:59 +01:00
			`### Added`

Support RP2040 PAC v0.5 in `rtic-monotonics` 2023-08-08 10:45:19 +02:00			`- RP2040 PAC 0.5 support`
Added nRF monotonics 2023-04-01 20:48:23 +02:00			`- nRF52xxx, nRF9160, nRF5340 Timer and RTC monotonics`
rtic-monotonics: Add interrupt tokens to make sure users bind interrupts 2023-03-11 20:47:39 +01:00			- Interrupt tokens for `Systick` and `rp2040` to make sure an interrupt handler exists

Add changelog templates 2023-01-28 11:15:59 +01:00			`### Changed`

Bump embedded-hal-async in rtic-monotonics 2023-08-20 13:00:33 +02:00			- Bump `embedded-hal-async`

Add changelog templates 2023-01-28 11:15:59 +01:00			`### Fixed`

rtic-monotonics: Unmask the RP2040 timer 2023-03-11 20:25:35 +01:00			- Unmask the `rp2040` interrupt
Support RP2040 PAC v0.5 in `rtic-monotonics` 2023-08-08 10:45:19 +02:00			- Use `$crate` and fully qualified paths in macros
rtic-monotonics: Unmask the RP2040 timer 2023-03-11 20:25:35 +01:00
Bump embedded-hal-async in rtic-monotonics 2023-08-20 13:00:33 +02:00			`## v1.0.0 - 2023-05-31`