alex/rp-hal-boards
1
0
Fork 0
mirror of https://github.com/italicsjenga/rp-hal-boards.git synced 2024-12-24 05:01:31 +11:00
Code Issues Packages Projects Releases Wiki Activity
rp-hal-boards/rp2040-hal/CHANGELOG.md
Jan Niehusmann f8984a9eac Implement conversion from Clock to Hertz using reference 
Implementing `impl From<SystemClock> for Hertz` is a footgun, as
SystemClock is not Copy, so the automatic conversion consumes the
owned clock.

This is visible in the example i2c.rs:

```
    let mut i2c = hal::I2C::i2c1(
        pac.I2C1,
        sda_pin,
        scl_pin, // Try `not_an_scl_pin` here
        400.kHz(),
        &mut pac.RESETS,
        clocks.peripheral_clock,
    );
```

If the user wants to use both `i2c0` and `i2c1` at the same time,
copying from this example won't work:

```
error[E0382]: use of moved value: `clocks.peripheral_clock`
   --> rp2040-hal/examples/i2c.rs:106:9
    |
97  |         clocks.peripheral_clock,
    |         ----------------------- value moved here
...
106 |         clocks.peripheral_clock,
    |         ^^^^^^^^^^^^^^^^^^^^^^^ value used here after move
    |
    = note: move occurs because `clocks.peripheral_clock` has type
`PeripheralClock`, which does not implement the `Copy` trait
```

As getting the frequency from a clock doesn't really need ownership,
changing it to `impl From<&SystemClock> for Hertz` is both more
logical and provides better usability.

This is, however, a breaking change: Code relying on this trait
implementation needs to be changed by adding a `&`.
2022-07-22 20:17:26 +00:00

4.1 KiB
Raw Blame History

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Changed

  • Update embedded-hal alpha support to version 1.0.0-alpha.8
  • Implement From<&SomeClock> for Hertz instead of From<SomeClock> for Hertz for the clocks in rp2040_hal::clocks.

0.5.0 - 2022-06-13

MSRV

The Minimum-Supported Rust Version (MSRV) for this release is 1.61

Added

  • RP2040 specific #[entry] macro that releases spinlocks - @jannic
  • Start multiple state machines in sync with each other - @astraw
  • Unsafe fn for freeing all spinlocks when you can't use the RP2040 entry macro (eg RTIC) - @9names
  • Optional feature for enabling defmt formatting for i2c errors - @ithinuel
  • Accessor for getting the offset of an installed PIO program - @fenax

Changed

  • Use thread send safe UART* marker when splitting, improves UART ergonmics - @marius-meissner
  • Improve performance for hardware division instrinsics. Internal intrinsics cleanup - @Sizurka
  • Provide a better alarm abstraction - @ithinuel
  • Update Multicore::spawn to be able to take a closure without requiring alloc. Improve Multicore ergonomics and add example for how to use new API - @Liamolucko
  • Allow PIO program to be 32 instructions long, was previously limited to 31 - @jannic
  • Fix Typos - @mqy, @danbev
  • Replace generic pio::Tx::write with write_u8_replicated, write_u16_replicated, and update write to take a u32. The generic version was too easy to misuse. - @9names

Removed

0.4.0 - 2022-03-09

Added

  • ROM function caching
  • ROM version lookup function
  • Compiler intrinsics for ROM functions
  • Compiler intrinsics for hardware divider
  • Document bsp_pins! macro
  • UART IRQ examples
  • PIO side-set example
  • Stopped PIO state machines can change their clock divider
  • Added HAL IRQ example

Changed

  • Rewrite UART driver to own its pins
  • Improve UART defaults
  • Fix repeated-read in i2c embassy driver
  • Fix bug in i2c peripheral state machine
  • Fix race condition in alarm
  • Fix safety bugs in hardware divider
  • Enable watchdog reset trigger bits when watchdog enabled
  • Update spinlocks to use new PAC API
  • Use generics to improve spinlock implementation
  • Update critical_section to use new spinlock implementation
  • Update embedded-hal alpha support to version 1.0.0-alpha.7
  • Avoid 64-bit division in clock calculations
  • Update pio and pio-proc to 0.2.0

0.3.0 - 2021-12-19

MSRV

The Minimum-Supported Rust Version (MSRV) for this release is 1.54.

Added

  • A README!
  • Implementation of the critical-section API
  • Embedded HAL 1.0-alpha6 support
  • I²C Controller and Peripheral support
  • Multi-core support, including spin-locks and SIO FIFO
  • RTC support
  • USB Device support
  • Timer support
  • PIO support
  • Implementation of rng_core::RngCore for RingOscillator
  • ADC example
  • GPIO Interrupt support
  • Multi-core FIFO example
  • PIO LED Blinky example
  • ROM Functions example
  • SPI example
  • Watchdog example
  • ADC documentation
  • Lots of bug fixes :)

Changed

  • Modified PIO API for better ergonomics
  • Updated PAC to 0.2.0
  • Exported common driver structs from top-level (e.g. it's now Sio, not sio::Sio)

0.2.0 - 2021-08-14

Added

  • Updated version with support for:
    • Ring Oscillator
    • Crystal Oscillator
    • Plls
    • Watchdog
    • Clocks
    • GPIO
    • PWM
    • ADC
    • SPI
    • I²C
    • Resets
    • UART
    • Hardware divide/modulo

0.1.0 - 2021-01-21

  • Initial release