search

esp-rs / esp-hal

no_std Hardware Abstraction Layers for ESP32 microcontrollers
https://docs.esp-rs.org/esp-hal/
Apache License 2.0
772 stars 214 forks source link

Stable driver analysis: SPI master #2494

Open MabezDev opened 2 weeks ago

MabezDev commented 2 weeks ago

As part of #2491, which has more details on driver analysis.

Note: we are not stabilizing DMA support right now.

esp-hal API-GUIDELINE omissions

Rust API guideline ommissions

Hardware feature omissions

Mode/features of the driver that are lacking

bugadani commented 2 weeks ago

Note: we are not stabilizing DMA support right now.

What exactly does this mean, we're only aiming at stabilizing spi::master::Spi? That's a surprisingly small slice of the driver.

MabezDev commented 2 weeks ago

What exactly does this mean, we're only aiming at stabilizing spi::master::Spi? That's a surprisingly small slice of the driver.

Start small, and incrementally stabilize. It's easier to stabilize spi::master::Spi and then SpiDma than both at the same time.

Remember folks can always opt in to unstable to use the rest of the driver. We need to be 100% certain what we're stabilizing is solid, there are no take-backsies till 2.0 :D.

(I just realized I basically summerised what I wrote in https://github.com/esp-rs/esp-hal/issues/2491, in particular the "Can the driver as a whole be stabilized" section.)