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.
No changes.
v0.10.0 - 2023-11-30
- Update
stm32f3
pac to v0.15.1 (#335) - Update
bxcan
pac to v0.7.0 (#335) - Remove
Toggle
enum and useSwitch
instead for better naming purposes - Fix undefined behavior in SPI implementation (#346)
- Add
num_traits::PrimInt
bounds toWord
- Add
- Remove
Serial::split
, which possibly creates two mutable references two one Serial instance, which could've caused UB. The use case of this function was hard to find out anyway. (#351) - Remove
defmt-*
features (defmt
feature is still available), to finalize migration fromdefmt-0.2.x
->defmt-0.3.x
. (#349) - Removed implicit
stm32-usbd
feature (useusb
instead) (#349)
- Fix wrong timer frequency calculation and unexpected panics (#338)
- Fixed integer saturation in Timer::start, see #342 (#356)
- The PWM implementation was deprecated. There is not yet an alternative implementation, but it is hard to maintain the current implementation and not easy to verify if it is really a safe implementation. It is also not consistent with the rest of the crates API. (#352)
- Use critical-section crate instead of
interrupt_free
, which is not always sound. (#350) It is also not consistent with the rest of the crates API. - The MSRV was bumped to 1.60 (#349)
v0.9.2 - 2023-02-20
- Add missing ADC channels (#337)
- Fix wrong timer frequency calculation and unexpected panics (#338)
- The MSRV was bumped to 1.59 (#340)
- Add a minimal DAC driver (#318)
- Missing
MosiPin
impl forPB5
(#322) - Read valid data from data register even if reception of next character has started (#317)
v0.9.0 - 2022-03-06
- Generic
into_af_push_pull<A>
andinto_af_open_drain<A>
(#308) BusClock
andBusTimerClock
traits (#302)RccBus
,Enable
,Reset
traits and implementations for peripherals (#299)- Support cortex-m-rt
v0.7.0
but still allowv0.6.13
(#283) - Make timer
InterruptTypes
fields public to be useful. (#304) - Add support for the internal signature peripheral (#281)
- Add common derives to
Toggle
. (#281) - Add
is_interrupt_configured
andconfigured_interrupts
function toserial::Serial
andtimer::Timer
. (#281)
- Fix
can
support. Can would not build forstm32f302x6
for example. Also supportcan
for every chip other thanstm32f301
andstm32f318
. (#283) - Fix wrong ADC votlage regulator startup time calculation effecting calibration. (#281)
- Make
rtc
an optional feature. Without that featurertcc
as a dependency is not needed. (#283) - Update
rtcc
tov0.3.0
. For a detailed changelog, go here. (#314) - Enable
rt
,usb
,can
,rtc
andld
feature by default. To disable that behavior, setdefault-features = false
. (#283) - The MSRV was bumped to 1.54 (#308)
- Update
stm32f3
pac to v0.14.0 (#282) - Remove the
bxcan
re-export. (#304) - The LICENSE has been changed from BSD 0-clause to the familiar dual license MIT / Apache 2.0. This has been done, as this fits the ecosystem better and the dependencies where using the MIT / Apache 2.0 dual licensing already, which resulted into the situtation, that BSD 0-clause was not affectivly 0-clause as MIT conditions had to be met anyways. (🧂 IANAL). (#309)
- Renamed
Serial::raw_read
toSerial::read_data_register
. (#281) - Seal
FlashExt
andRccExt
traits. These are no longer implementable by a user of this crate. (#281) - Move ADC from a macro to a generic implementation, meaning that
it is possible to obtain an ADC instance via
Adc::new
instead ofAdc::adc1
. (#281) - Remove
adc::ClockMode
and the clock configuration of the ADC.- Clock configuration effects the common ADC which inturn controls e.g. ADC1 and ADC2, which the old API did not resemble.
- The API provides no clock configuration for ADC peripherals yet, but
correctly acts upon changes done through the
pac
. (#281)
- Major rework of the ADC implementation: (#281)
- Add
CommonAdc
support. - Add internal sensor peripheral support like
TemeperaturSensor
and similar. - Lift restriction of the ADC implementation for
stm32f303
, thoughstm32f373
is still not supported. - Enable manual configuration of the Adc peripheral of most important features
ConversionMode
Sequence
lengthOverrunMode
- etc.
- Leverage type states to:
- Allow a
Disabled
ADC, which can be manually calibrated. - Allow a
OneShot
ADC implementation throughinto_oneshot
with an optimal configuration for theOneShot
embedded-hal trait.
- Allow a
- Support every possible ADC channel.
- Add interrupt support.
- Add
- Add missing SPI impls for the
gpio-f303
device groups (e.g. stm32f303vc) (#304)
v0.8.1 - 2021-10-27
- ADC Channel SMP Register mismatch. (#291)
- While
read()
ing a Pin mapped to channel10
and unexpected panic happened.
- While
v0.8.0 - 2021-08-16
- Readd MonoTimer. This was accidentally removed before. (#247)
- Different to before, frequency() and now() now do not consume the MonoTimer.
&self
is used instead. (#267)
- Different to before, frequency() and now() now do not consume the MonoTimer.
- Basic serial implementation also available for UART4 and UART5 (#246)
- Implement serial DMA also for Serial (#246)
- Add
enumset
as a optional dependency, which allow more ergonomic functions regarding enums. This is especially useful for status event query functions. (#253) - As serial
Error
and serialEvents
share things in common.TryFrom<Event>
andFrom<Error>
is implemented for conversions. (#253) - Add serial character match function, with which events can be triggered for the set character. (#253)
- Add receiver timeout function, which configures the serial peripheral to trigger an event, if nothing happened after a certain time on the serial receiver line. (#253)
- Add
raw_read()
function, which does no error handling and also does not clear anyEvent
by itself. Useful, if the error_handling has to be done in another context (like an interrupt rountine). (#253) - Introduce
Toggle
, withOn
andOff
as a convinience wrapper aroundbool
for configuration purposes. (#253) - Add an associated const to
serial::Instance
to return the correspondingpac::Interrupt
-number, which is useful tounmask()
interrupts. Aninterrupt()
function toSerial
was also added for convinience. (#253) - Add a
Serial::is_busy()
function to check, if the serial device is busy. Useful to block on this function, e.g.while serial.is_busy() {}
. (#253) - Add
BaudTable
a convinience wrapper aroundBaud
to configure theSerial
to the most commen baud rates. (#253) - Add
Serial::detect_overrun()
function, to en- or disable the overrun detection of theSerial
. If overrun is disabled (enabled by default), than newly arrived bytes are overwriting the current data in the read receive register without throwing any event. (#253). - Lift generic constraint of most
Serial
method onTxPin
andRxPin
. This should make it easier to generically use theSerial
peripheral. (#253) - Greatly increase coverage of
Debug
anddefmt::Format
implementations. Almost all important types should now be supported. (#265) - Add a
free()
function to the RTC implementation to retrieve the passed-in peripheral. (#266) - Implement an API to return the corresponding interrupt number of timer through
the newly introduced
InterruptNumber
trait, where theInterrupt
is held as an associated const. (#267)- Depending on the timer one
Interrupt
or a bundle ofInterruptTypes
is returned. - On the bases of these interrupts, the interrupt controller (NVIC) can be set to mask or unmask these interrupts.
- Depending on the timer one
- Implement the
embedded-hal::timer::Cancel
trait for timers. (#267) - Add
use_pll
toCFGR
- the clock configuration - to force to use the PLL source for the systemclock. AlsoClocks::pllclk()
was introduced to be able to check, whether PLL is used. - Add unsafe peripheral function to access underlying peripheral (#277)
- Implement
fmt::Write
forSerial
(#278)- This allowes using
writeln!
in combination withSerial
.
- This allowes using
PXx
struct (representing a generic GPIO pin) implementsSend
andSync
(#251)- Each pin aliases (
PA0
,PA1
, ..) are defined undergpio
module directly. Re-export from gpio port sub-modules are provided for compatibility. (#257) - The
embedded-hal
Read implementation ofSerial
does now returnWoudBlock
if the peripheral is busy. Also if anOverrun
occured the receive data register (RDR) is flushed to have a more consistent API. (#253) - Remove
cargo-metadata
as a build dependency to cut down dependencies and the reliance onresolver = "2"
. (#270)
- The "unproven" feature, which itself does enable the "embedded-hal/unproven"
features, can no longer be disabled. (#259)
- The "unproven" features are no longer unproven and used anywhere anyways.
- This crate was not building successfully without the unproven feature.
- Set the correct baud rate for chips where
USART1SW_A::PCLK
leads to a baud rate derived from PCLK1, rather than the ports own bus clock, PCLK2. (#260)
- Refactor CAN to use the
bxCan
crate. (#207) - Add support for configuring parity and stop bits in addition to baud rate for
Serial
withserial::config::Config
. (#239) - Implement
Serial::join
which allows to re-create the serial peripheral, whenSerial::split
was previously called. (#252) - Parameterized
usb::Peripheral
andusb::UsbType
on the pin configuration used (#255) - Add (almost) all missing serial (interrupt and status) events. Also rename all the event names to be more descriptive. (#253)
- A new serial interrupt API was introduced: (#253)
listen()
andunlisten()
are renamed toenable_interrupt()
anddisable_interrupt()
.is_tc()
and other non-parametrizable functions are removed.configure_interrupt()
was added, which can be parameterized.clear_event()
was added to clear specific events.clear_events()
was added to clear all events at once.is_event_triggered()
can check if anEvent
is triggered.triggered_events
returns anEnumSet
of triggered events.
- Change gpio interrupt API to be more in line with the new serial interrupt API. (#262)
- Move EXTI interrupt management to SysCfg. (#262)
- Becuase EXTI interrupt confiugration could cancel out, make it more obvious
in that SysCfg manages the interrupts, not the pin itself.
Change
make_interrupt_source()
toSysCfg::select_exti_interrupt_source()
.
- Becuase EXTI interrupt confiugration could cancel out, make it more obvious
in that SysCfg manages the interrupts, not the pin itself.
Change
- Change dma interrupt API to be more in line with the new serial interrupt API. (#263)
- Change timer interrupt API to the same of the serial interface. (#264)
- Make timer Events
#[non_exhaustive]
. (#264) - Renames timers
release()
function tofree()
to be more in line with the rest of this crate. (#264) - rtc's
Error
type andOperationMode
andCkMode
of adc are now#[non_exhaustive]
. (#266) - All non-camel-case types are chaged to be consistently camel-case types.
Types which do not follow these rules are re-exported types by
stm32f3
for example. (#266) - Adc's
SampleTime
type has been reworked and is now a consistent wrapper around the underlying types forstm32f3
'sSMP9_A
andSMP18_A
type. (#266) - Rename
CkMode
toClockMode
(#266) - Rename
stm32-usbd
feature tousb
.stm32-usbd
is still used as a dependency. (#271) - Rework the timer implementation: (#267)
PclkSrc
trait was removed in favor of genericInstance
trait, which is a common ground for all available timers.Timer::tim1
and so on are renamed toTimer::new
- The implementation of the timers are corrected to better represent the avaibilities of timers of the hardware.
Timer::new
now does not take a timeout value. This means, that the timer will now not be started automatically and one has to explicitly callstart()
.
- Rework SPI implementation: (#273)
- A generic
Instance
trait now represents all Spi peripherals. Spi::spi1
and so on are renamed toSpi::new
.- Add SPI configuration type to be passed into
Spi::new
- A generic
- Remove public fields from
Adc
andRtc
(#277)
v0.7.0 - 2021-06-18
- Make
Clocks
ppre1()
andppre2()
methods public, to get the current Prescaler value. (#210) - Support for more CAN bit rates and modes. (#186)
- Implement
into_xxx
methods for partially erased pins (#189) - Enable better GPIO internal resistor configuration (#189)
- Support for GPIO output slew rate configuration (#189)
- Support for GPIO interrupts (#189)
ld
feature, which enables the memory.x generation (#216)- Implement
DelayMs
forMilliseconds
andDelayUs
forMicroseconds
(#234) - ADC can now be
free()
'd (#212) - Serial does now implement
embedded_hal::serial::{Read, Write}
. Nosplit()
necessary. (#232) - Serial can now listen for the "Transmission Complete"
Tc
interrupt event (#232) - Serial can now listen for the
Idle
interrupt event (#238)
- The structure of
gpio.rs
is greatly changed. GenericPin
struct is used for every GPIO pin now (#189)
- Delay based on systick no longer panics (#203) for to high values and support longer delays (#208)
- Long delay during ADC initialization (#217)
- The MSRV was bumped to 1.51 (#227)
- Replace custom time based units with types defined in the embedded-time crate (#192)
- The
rcc
public API now expects time based units inMegahertz
. If the supplied frequency cannot be converted toHertz
the code willpanic
. This will occur if the suppliedMegahertz
frequency cannot fit intou32::MAX
when converting toHertz
(#192)
// The supplied frequencies must be in `MHz`.
let clocks = rcc
.cfgr
.use_hse(8.MHz())
.hclk(48.MHz())
.sysclk(48.MHz())
.pclk1(12.MHz())
.pclk2(12.MHz())
- You always required to select a sub-target for target chips (#216)
- Bump dependencies: (#229)
cortex-m
to 0.7.2cortex-m-rt
to 0.6.4defmt
to 0.2.2embedded-hal
to 0.2.5nb
to 1.0.0stm32f3
to 0.13.2stm32-usbd
to 0.6.0
into_afx
methods are splitted intointo_afx_push_pull
andinto_afx_open_drain
(#189)- GPIO output mode (
PushPull
orOpenDrain
) is encoded into pin typestate in alternate function mode (#189) - GPIO internal resistor configuration is no longer encoded into pin typestate in input mode (#189)
- Remove
stm32
module. Useuse stm32f3xx_hal::pac
instead. This module was a deprecated in v0.5.0 and is now subject for removal. (#220) Serial::uart1
... functions are renamed toSerial::new
. (#212)
v0.6.1 - 2020-12-10
- Removed
doc-comment
dependency (#184)
v0.6.0 - 2020-12-10
- Support for 16-bit words with SPI (#107)
- SPI support for reclock after initialization (#98)
- Support for
stm32f302x6
andstm32f302x8
devices (#132) - Support for the onboard real-time clock (RTC) (#136)
- Enable DMA for USART on
stm32f302
devices (#139) - Basic CAN bus support (#100)
- Impls for all SPI pins for all
stm32f302
sub-targets,stm32f303
subtargets,stm32f3x8
targets,stm32f334
, andstm32f373
(#99) - SPI4 peripheral for supported devices. (#99)
- Support for I2C transfer of more than 255 bytes, and 0 byte write (#154)
- Support for HSE bypass and CSS (#156)
- Impls for missing I2C pin definitions (#164)
- Support I2C3 (#164)
- Support for
defmt
(#172)- Now defmt features are available.
- Currently these are only used for panicking calls, like
assert!
panic!
orunwrap()
. These are enabled using the defmt filter. - For now defmt is mostly intended for internal development and testing to further reduce panicking calls in this crate. The support of this feature is subject to change as the development of defmt is advancing.
- Introduced auto-generated GPIO mappings based on the STM32CubeMX database (#129)
- Fixed #151 not being able to generate 72 MHz HCLK for stm32f303xc devices (#152)
- Wrong I2C clock source (#164)
- Removed impl for
SckPin<SPI2>
forPB13<AF5>
fromstm32f328
andstm32f378
targets. (#99) - Removed SPI1 support for
stm32f302x6
andstm32f302x8
sub-targets andstm32f318
target. (#99) - This release requires 1.48, as intra-doc-links are now used internally. Until now, no MSRV was tracked. This has changed now. This however does not mean, that we guarantee any MSRV policy. It is rather for documentation purposes and if a new useful feature arises, we will increase the MSRV. (#170)
- Removed I2C2 support for
stm32f303x6
,stm32f303x8
andstm32f328
targets. (#164) I2c::i2c1
andI2c::i2c2
functions are renamed toI2c::new
. (#164)
v0.5.0 - 2020-07-21
- Implement
InputPin
forOutput<OpenDrain>
pins (#114) - Support for safe one-shot DMA transfers (#86)
- DMA support for serial reception and transmission (#86)
- ADC support for
stm32f303
devices (#47)
PLL
was calculated wrong for devices, which do not divideHSI
(#67)
- The system clock calculation is more fine grained now. (#67) Now the system clock can be some value, like 14 MHz, which can not a be represented as a multiple of the oscillator clock:
let clocks = rcc
.cfgr
.use_hse(8.mhz())
.sysclk(14.mhz())
// or
let clocks = rcc
.cfgr
.use_hse(32.mhz())
.sysclk(72.mhz())
This is possible through utilizing the divider, which can divide the external oscillator clock on most devices. Some devices have even the possibility to divide the internal oscillator clock.
- The feature gate requires you to select a subvariant if possible. (#75)
- Split up
stm32f302
into sub-targetsstm32f302xb
,stm32f302xc
,stm32f302xd
,stm32f302xe
- Bump
stm32f3
dependency to0.11.0
(#97) - The
stm32f3
reexport is now renamed fromstm32
topac
(#101) - The correct
stm32f3
modules are now used for thestm32f318
andstm32f738
targets. As a result, some previously (wrongly) supported peripherals have been removed from these targets. (#116)
v0.4.3 - 2020-04-11
- Independent Watchdog (#58)
- Wrong default modes for debug GPIO pins (#82)
- Wrong calculation of HCLK prescaler, if using a prescaler value equal or higher than 64 (#42)
- UART reception error flags not cleared (#91)
v0.4.2 - 2020-03-21
- Bump
stm32f3
dependency to0.10.0
(#70)
v0.4.1 - 2020-03-07
- Use Infallible error type for UART (#50)
- Implement blocking Write for UART (#50)
- Implement blocking Read for I2C (#52)
- Regression in v0.4.0 that set SPI to LSB-first ordering (#60)
v0.4.0 - 2019-12-27
- USB Driver for all devices except
stm32f301
andstm32f334
as they have no USB peripheral. (#24) StatefulOutputPin
andToggleableOutputPin
(#25)- Support devices with 2-bit PLLSRC fields (#31)
- This allows using 72 MHz
sysclk
on thestm32f303
- This allows using 72 MHz
- Analog gpio trait (#33)
- Add PWM Channels (#34)
- SPI embedded hal modes are now public (#35)
- Alternate gpio functions are now only made available for devices, which have them. (#21)
stm32f303
is now split intostm32f303xd
andstm32f303xe
as they provide different alternate gpio functions.stm32f303
is still available.- Bump
stm32f3
dependency to0.9.0
(#39)
- Fixed wrong initialization of the SPI (#35)
v0.3.0 - 2019-08-26
- HSE and USB clock are now supported (#18)
- Bump
stm32f3
version to0.8.0
(#19)
v0.2.3 - 2019-07-07
- Fix timer initialization (#17)
v0.2.2 - 2019-07-06
- Missing
stm32f303
timers (#16)
v0.2.1 - 2019-07-06
- Fully erased pin (#14)
v0.2.0 - 2019-07-02
- Various peripheral mappings for some devices (#12)
- Switch to the
embedded-hal
v2 digital pin trait.
v0.1.5 - 2019-06-11
- Support for GPIO AF14 (#6)
v0.1.4 - 2019-05-04
- Fixed I2C address (#4)
v0.1.3 - 2019-04-12
- Implement GPIO
InputPin
traits (#2)
v0.1.2 - 2019-04-06
- Support
stm32f328
,stm32f358
andstm32f398
devices - Support
stm32f334
device - Support
stm32f378
device - Support
stm32f373
device
v0.1.1 - 2019-03-31
- Support
stm32f301
andstm32f318
devices - Support
stm32f302
device
- Support
stm32f303
device