Unify: Remove the chip-specific HAL packages, adapt `esp-hal` for direct use [1/?] #1196

jessebraham · 2024-02-21T18:34:25Z

After months of working towards this, I've finally pulled the trigger and unified the HAL packages (rejoice!).

There is still a fair bit of work left to do here, however I'm opting to leave that for a subsequent PR. Namely, documentation and READMEs need updating, but I'm sure there is a bunch of small stuff that needs fixing/cleaning.

In addition to the direct work on the HAL, I've also pretty much completely rewritten the CI workflow at this point. There is still some work to be done on it, but it's much smaller and simpler than it was before at least.

All examples for a chip can be built using the xtask package:

cargo xtask build-examples esp-hal esp32c6

You can run examples using one of the provided cargo aliases:

cd examples/
cargo +esp esp32 --example=hello_world

I think most of these changes should be pretty straight forward, the bulk of it is just updating the CI and examples. I've made a lot of assumptions here, and just sort of went for it with regards to making decisions, so if you see anything questionable please don't hesitate to let me know, I'm happy to make whatever changes are necessary.

We will need plenty of eyes on this, plus it would be nice to test as many examples as reasonably possible on hardware. Would appreciate some help with that aspect! One thing I'm a little worried about in particular is the default features; I think I have managed to do the same we were doing before, but hard to say at this point 😅

For context, see #446

…2/S2

…g examples

…n in CI

…ature

SergioGasquez

Thanks for making this huge effort of unification! LGTM, just left a few small comments and typos.

examples/src/bin/lp_core_uart.rs

examples/src/bin/pcnt_encoder.rs

examples/src/bin/psram.rs

examples/src/bin/sleep_timer_rtcio.rs

examples/src/bin/qspi_flash.rs

examples/.cargo/config.toml

bjoernQ · 2024-02-22T08:27:17Z

The "bluetooth" feature is gone - it was used to reserve memory for bluetooth on ESP32

bjoernQ · 2024-02-22T08:28:21Z

We used to re-export riscv and xtensa-lx before. riscv is gone but we should do it. It was a constant source of pain before and should be aligned with Xtensa

esp-hal/Cargo.toml

Co-authored-by: Björn Quentin <bjoernQ@users.noreply.github.com>

esp-hal/src/lib.rs

MabezDev · 2024-02-22T10:22:15Z

Not sure how to solve this, but when running an example on an unsupported chip you get an confusing error, e.g dac on esp32c3:

error[E0432]: unresolved import `esp_hal::dac`
  --> src/bin/dac.rs:17:5
   |
17 |     dac::{DAC1, DAC2},
   |     ^^^ could not find `dac` in `esp_hal`

I hope we can find a nice way to say this isn't supported on that chip.

examples/src/bin/blinky_erased_pins.rs

examples/src/bin/debug_assist.rs

examples/src/bin/ecc.rs

examples/src/bin/hello_rgb.rs

examples/src/bin/i2c_display.rs

examples/src/bin/mcpwm.rs

examples/src/bin/rmt_tx.rs

examples/src/bin/sha.rs

jessebraham · 2024-02-22T18:26:10Z

Not sure how to solve this, but when running an example on an unsupported chip you get an confusing error, e.g dac on esp32c3:
error[E0432]: unresolved import `esp_hal::dac`
  --> src/bin/dac.rs:17:5
   |
17 |     dac::{DAC1, DAC2},
   |     ^^^ could not find `dac` in `esp_hal`
I hope we can find a nice way to say this isn't supported on that chip.

Yeah, I don't have a good solution for this unfortunately.

examples/src/bin/systimer.rs

esp-hal/Cargo.toml

* Fix RMT examples * Remove logger-init

jessebraham · 2024-02-26T14:19:18Z

Clippy is going to fail today, we're just going to ignore it for now.

* Make I2S examples work on ESP32 * Remove logger init

examples/src/bin/clock_monitor.rs

* Switch to generic queue instead of integrated for all examples * changelog

* Avoid UART0 and SPI flash pins * Fix spi_eh1_device_loopback for non-ESP32 * Update examples/src/bin/gpio_interrupt.rs Co-authored-by: Juraj Sadel <jurajsadel@gmail.com> --------- Co-authored-by: Juraj Sadel <jurajsadel@gmail.com>

bjoernQ

LGTM - Thanks for all the effort

jessebraham · 2024-02-27T14:09:48Z

jessebraham added 10 commits February 21, 2024 10:22

Remove the chip-specific HAL packages

a7a3378

Update some doc comments which were missed, fix build script for ESP3…

a8290b3

…2/S2

Refactor/update esp-hal-procmacros

9da3996

Create the examples package, add back all of the previously existin…

b0fabc9

…g examples

Use xtask automation package for checking examples and documentatio…

6cd5944

…n in CI

Combine the rt-riscv and rt-xtensa features into a single rt fe…

a0b3a90

…ature

Bump MSRV to 1.76.0 (shocking!)

84e2173

Re-document the features for the HAL

acf7030

No need to re-export the riscv package like this

e1179f2

Make clippy happy, improve CI clippy checks

954f0b8

jessebraham requested review from bjoernQ, MabezDev, SergioGasquez, JurajSadel and playfulFence February 21, 2024 18:34

Update CHANGELOG.md

2ae8665

jessebraham mentioned this pull request Feb 21, 2024

RFC: Unify the HAL #446

Closed

4 tasks

SergioGasquez approved these changes Feb 21, 2024

View reviewed changes

bjoernQ reviewed Feb 22, 2024

View reviewed changes

examples/.cargo/config.toml Outdated Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

bjoernQ reviewed Feb 22, 2024

View reviewed changes

esp-hal/Cargo.toml Outdated Show resolved Hide resolved

bjoernQ reviewed Feb 22, 2024

View reviewed changes

esp-hal/Cargo.toml Outdated Show resolved Hide resolved

riscv: zero bss

700e2d4

Co-authored-by: Björn Quentin <bjoernQ@users.noreply.github.com>

bjoernQ reviewed Feb 22, 2024

View reviewed changes

esp-hal/src/lib.rs Show resolved Hide resolved

SergioGasquez reviewed Feb 22, 2024

View reviewed changes

examples/src/bin/blinky_erased_pins.rs Show resolved Hide resolved

SergioGasquez reviewed Feb 22, 2024

View reviewed changes

examples/src/bin/debug_assist.rs Outdated Show resolved Hide resolved

SergioGasquez reviewed Feb 22, 2024

View reviewed changes

examples/src/bin/ecc.rs Show resolved Hide resolved

examples/src/bin/hello_rgb.rs Show resolved Hide resolved

examples/src/bin/i2c_display.rs Outdated Show resolved Hide resolved

SergioGasquez reviewed Feb 22, 2024

View reviewed changes

examples/src/bin/mcpwm.rs Show resolved Hide resolved

examples/src/bin/rmt_tx.rs Outdated Show resolved Hide resolved

bjoernQ reviewed Feb 22, 2024

View reviewed changes

examples/src/bin/sha.rs Outdated Show resolved Hide resolved

Address a number of review comments

22e820d

jessebraham added 2 commits February 22, 2024 10:41

Correct pin number in hello_rgb example for ESP32-C3

8127c67

Address the remaining review comments

a50a7f0

jessebraham commented Feb 22, 2024

View reviewed changes

examples/src/bin/systimer.rs Outdated Show resolved Hide resolved

More small tweaks/improvements

f0fb458

bjoernQ reviewed Feb 23, 2024

View reviewed changes

esp-hal/Cargo.toml Show resolved Hide resolved

Fix RMT examples (#11)

e76c5ee

* Fix RMT examples * Remove logger-init

bjoernQ and others added 2 commits February 26, 2024 06:21

Make I2S examples work on ESP32 (#12)

f5ba872

* Make I2S examples work on ESP32 * Remove logger init

Fix the direct-vectoring examples on all RISCV chips (#10)

7763036

MabezDev reviewed Feb 26, 2024

View reviewed changes

examples/src/bin/clock_monitor.rs Show resolved Hide resolved

jessebraham and others added 3 commits February 26, 2024 08:15

Update GPIOs for some examples...

7089d55

Embassy timer example fixes (#13)

37a616b

* Switch to generic queue instead of integrated for all examples * changelog

Update GPIO in another example, make rustfmt happy

fa9f68e

This was referenced Feb 27, 2024

Add TimerWakeupSource for the esp32-c6 deepsleep. #1201

Merged

ESP32-C2: spi-slave-dma seems broken #1206

Closed

ESP32-C3: TWAI broken when using GPIO1 for RX #1207

Closed

ESP32-S2: I2C problems #1208

Closed

bjoernQ and others added 2 commits February 27, 2024 13:47

Fix ESP32-S2 PSRAM

2792807

Avoid UART0 and SPI flash pins (#15)

8619c9e

* Avoid UART0 and SPI flash pins * Fix spi_eh1_device_loopback for non-ESP32 * Update examples/src/bin/gpio_interrupt.rs Co-authored-by: Juraj Sadel <jurajsadel@gmail.com> --------- Co-authored-by: Juraj Sadel <jurajsadel@gmail.com>

bjoernQ approved these changes Feb 27, 2024

View reviewed changes

jessebraham added this pull request to the merge queue Feb 27, 2024

Merged via the queue into esp-rs:main with commit 6a663f8 Feb 27, 2024
17 of 18 checks passed

jessebraham deleted the feature/unify-1 branch February 27, 2024 14:49

MabezDev mentioned this pull request Feb 28, 2024

Use the "generic-queue" from embassy-time instead of the "integrated-timers" from embassy-executor #1087

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unify: Remove the chip-specific HAL packages, adapt `esp-hal` for direct use [1/?] #1196

Unify: Remove the chip-specific HAL packages, adapt `esp-hal` for direct use [1/?] #1196

jessebraham commented Feb 21, 2024 •

edited

Loading

SergioGasquez left a comment

bjoernQ commented Feb 22, 2024

bjoernQ commented Feb 22, 2024 •

edited

Loading

This comment was marked as outdated.

MabezDev commented Feb 22, 2024

jessebraham commented Feb 22, 2024

jessebraham commented Feb 26, 2024

bjoernQ left a comment

jessebraham commented Feb 27, 2024

Unify: Remove the chip-specific HAL packages, adapt esp-hal for direct use [1/?] #1196

Unify: Remove the chip-specific HAL packages, adapt esp-hal for direct use [1/?] #1196

Conversation

jessebraham commented Feb 21, 2024 • edited Loading

SergioGasquez left a comment

Choose a reason for hiding this comment

bjoernQ commented Feb 22, 2024

bjoernQ commented Feb 22, 2024 • edited Loading

This comment was marked as outdated.

MabezDev commented Feb 22, 2024

jessebraham commented Feb 22, 2024

jessebraham commented Feb 26, 2024

bjoernQ left a comment

Choose a reason for hiding this comment

jessebraham commented Feb 27, 2024

Unify: Remove the chip-specific HAL packages, adapt `esp-hal` for direct use [1/?] #1196

Unify: Remove the chip-specific HAL packages, adapt `esp-hal` for direct use [1/?] #1196

jessebraham commented Feb 21, 2024 •

edited

Loading

bjoernQ commented Feb 22, 2024 •

edited

Loading