Unify: rename the esp-hal-common package to esp-hal [0/?] (#1131)

* Rename the `esp-hal-common` package to `esp-hal`

* Update all references to `esp-hal-common`

* Update `CHANGELOG.md`

.github/workflows/ci.yml

@@ -765,8 +765,8 @@ jobs:
       - uses: Swatinem/rust-cache@v2
 
       # Check the formatting of all packages:
-      - name: rustfmt (esp-hal-common)
-        run: cargo fmt --all --manifest-path=esp-hal-common/Cargo.toml -- --check
+      - name: rustfmt (esp-hal)
+        run: cargo fmt --all --manifest-path=esp-hal/Cargo.toml -- --check
       - name: rustfmt (esp-hal-procmacros)
         run: cargo fmt --all --manifest-path=esp-hal-procmacros/Cargo.toml -- --check
       - name: rustfmt (esp-hal-smartled)

CHANGELOG.md

@@ -17,7 +17,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - ESP32-P4: Add initial support for interrupts (#1112)
 - ESP32-P4: Add efuse reading support (#1114)
 - ESP32-S3: Added LCD_CAM I8080 driver (#1086)
-
 - Allow for splitting of the USB Serial JTAG peripheral into tx/rx components (#1024)
 - `RngCore` trait is implemented (#1122)
 
@@ -32,6 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - DmaDescriptor struct to better model the hardware (#1054)
 - DMA descriptor count no longer needs to be multiplied by 3 (#1054)
 - RMT channels no longer take the channel number as a generic param (#959)
+- The `esp-hal-common` package is now called `esp-hal` (#1131)
 
 ### Removed
 

esp-hal-smartled/Cargo.toml

@@ -12,19 +12,19 @@ features = ["esp32c3"]
 
 [dependencies]
 defmt            = { version = "=0.3.5", optional = true }
-esp-hal-common   = { version = "0.15.0", path = "../esp-hal-common" }
+esp-hal          = { version = "0.15.0", path = "../esp-hal" }
 fugit            = "0.3.7"
 smart-leds-trait = "0.3.0"
 
 [features]
-esp32   = ["esp-hal-common/esp32"]
-esp32c3 = ["esp-hal-common/esp32c3"]
-esp32c6 = ["esp-hal-common/esp32c6"]
-esp32h2 = ["esp-hal-common/esp32h2"]
-esp32s2 = ["esp-hal-common/esp32s2"]
-esp32s3 = ["esp-hal-common/esp32s3"]
+esp32   = ["esp-hal/esp32"]
+esp32c3 = ["esp-hal/esp32c3"]
+esp32c6 = ["esp-hal/esp32c6"]
+esp32h2 = ["esp-hal/esp32h2"]
+esp32s2 = ["esp-hal/esp32s2"]
+esp32s3 = ["esp-hal/esp32s3"]
 
-xtal-26mhz = ["esp-hal-common/xtal-26mhz"]
-xtal-40mhz = ["esp-hal-common/xtal-40mhz"]
+xtal-26mhz = ["esp-hal/xtal-26mhz"]
+xtal-40mhz = ["esp-hal/xtal-40mhz"]
 
-defmt = ["dep:defmt", "esp-hal-common/defmt"]
+defmt = ["dep:defmt", "esp-hal/defmt"]

esp-hal-smartled/src/lib.rs

@@ -24,7 +24,7 @@
 
 use core::{fmt::Debug, slice::IterMut};
 
-use esp_hal_common::{
+use esp_hal::{
     gpio::OutputPin,
     peripheral::Peripheral,
     rmt::{Error as RmtError, PulseCode, TxChannel, TxChannelConfig, TxChannelCreator},

esp-hal-common/Cargo.toml → esp-hal/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name         = "esp-hal-common"
+name         = "esp-hal"
 version      = "0.15.0"
 edition      = "2021"
 rust-version = "1.67.0"
@@ -12,7 +12,7 @@ license      = "MIT OR Apache-2.0"
 # confusing build errors due to expected features not getting enabled
 # on the unintentional copy.
 # This is especially common when mixing crates from crates.io and git.
-links = "esp-hal-common"
+links = "esp-hal"
 
 [dependencies]
 bitflags             = "2.4.2"
@@ -175,7 +175,7 @@ debug = [
     "esp32s3?/impl-register-debug",
 ]
 
-# Enable support for `defmt`, for `esp-hal-common` and also for all our dependencies
+# Enable support for `defmt`, for `esp-hal` and also for all our dependencies
 defmt = [
     "dep:defmt",
     "embassy-executor?/defmt",

esp-hal-common/README.md → esp-hal/README.md

@@ -1,8 +1,8 @@
-# esp-hal-common
+# esp-hal
 
-[![Crates.io](https://img.shields.io/crates/v/esp-hal-common?labelColor=1C2C2E&color=C96329&logo=Rust&style=flat-square)](https://crates.io/crates/esp-hal-common)
-[![docs.rs](https://img.shields.io/docsrs/esp-hal-common?labelColor=1C2C2E&color=C96329&logo=rust&style=flat-square)](https://docs.rs/esp-hal-common)
-![Crates.io](https://img.shields.io/crates/l/esp-hal-common?labelColor=1C2C2E&style=flat-square)
+[![Crates.io](https://img.shields.io/crates/v/esp-hal?labelColor=1C2C2E&color=C96329&logo=Rust&style=flat-square)](https://crates.io/crates/esp-hal)
+[![docs.rs](https://img.shields.io/docsrs/esp-hal?labelColor=1C2C2E&color=C96329&logo=rust&style=flat-square)](https://docs.rs/esp-hal)
+![Crates.io](https://img.shields.io/crates/l/esp-hal?labelColor=1C2C2E&style=flat-square)
 [![Matrix](https://img.shields.io/matrix/esp-rs:matrix.org?label=join%20matrix&labelColor=1C2C2E&color=BEC5C9&logo=matrix&style=flat-square)](https://matrix.to/#/#esp-rs:matrix.org)
 
 `no_std` HAL implementations for the peripherals which are common among Espressif devices. Implements a number of the traits defined by [embedded-hal](https://github.com/rust-embedded/embedded-hal).
@@ -19,7 +19,7 @@ This crate should not be used directly; you should use one of the device-specifi
 
 ## [Documentation]
 
-[documentation]: https://docs.rs/esp-hal-common/
+[documentation]: https://docs.rs/esp-hal/
 
 ## License
 

esp-hal-common/src/mcpwm/mod.rs → esp-hal/src/mcpwm/mod.rs

@@ -28,7 +28,7 @@
 //! signal at 20 kHz. The signal will be output to the pin assigned to `pin`.
 //!
 //! ```no_run
-//! # use esp_hal_common::{mcpwm, prelude::*};
+//! # use esp_hal::{mcpwm, prelude::*};
 //! use mcpwm::{operator::PwmPinConfig, timer::PwmWorkingMode, PeripheralClockConfig, MCPWM};
 //!
 //! // initialize peripheral

esp32-hal/Cargo.toml

@@ -22,7 +22,7 @@ categories = [
 
 [dependencies]
 document-features   = "0.2.7"
-esp-hal-common      = { version = "0.15.0", features = ["esp32"], path = "../esp-hal-common" }
+esp-hal             = { version = "0.15.0", features = ["esp32"], path = "../esp-hal" }
 embassy-time-driver = { version = "0.1.0",  optional = true }
 
 [dev-dependencies]
@@ -54,55 +54,55 @@ default = ["embassy-integrated-timers", "rt", "vectored", "xtal-40mhz"]
 ## Enable support for using the Bluetooth radio.
 bluetooth = []
 ## Enable debug features in the HAL (used for development).
-debug = ["esp-hal-common/debug"]
+debug = ["esp-hal/debug"]
 ## Enable logging output using the `log` crate.
-log = ["esp-hal-common/log", "esp-println/log"]
+log = ["esp-hal/log", "esp-println/log"]
 ## Enable runtime support.
-rt = ["esp-hal-common/rt-xtensa"]
+rt = ["esp-hal/rt-xtensa"]
 ## Enable interrupt vectoring.
-vectored = ["esp-hal-common/vectored"]
+vectored = ["esp-hal/vectored"]
 ## Target device has a 26MHz crystal.
-xtal-26mhz = ["esp-hal-common/xtal-26mhz"]
+xtal-26mhz = ["esp-hal/xtal-26mhz"]
 ## Target device has a 40MHz crystal.
-xtal-40mhz = ["esp-hal-common/xtal-40mhz"]
+xtal-40mhz = ["esp-hal/xtal-40mhz"]
 
 #! ### Trait Implementation Feature Flags
 ## Enable support for asynchronous operation, with interfaces provided by
 ## `embedded-hal-async` and `embedded-io-async`.
-async = ["esp-hal-common/async"]
+async = ["esp-hal/async"]
 ## Implement `defmt::Format` on certain types.
-defmt = ["esp-hal-common/defmt", "esp-println/defmt-espflash"]
+defmt = ["esp-hal/defmt", "esp-println/defmt-espflash"]
 ## Implement the traits defined in the `1.0.0` releases of `embedded-hal` and
 ## `embedded-hal-nb` for the relevant peripherals.
-eh1 = ["esp-hal-common/eh1"]
+eh1 = ["esp-hal/eh1"]
 ## Implement the traits defined in `embedded-io` for certain peripherals.
-embedded-io = ["esp-hal-common/embedded-io"]
+embedded-io = ["esp-hal/embedded-io"]
 ## Implement the `ufmt_write::uWrite` trait for certain peripherals.
-ufmt = ["esp-hal-common/ufmt"]
+ufmt = ["esp-hal/ufmt"]
 
 #! ### PSRAM Feature Flags
 psram = []
 ## Use externally connected PSRAM (2MB).
-psram-2m = ["esp-hal-common/psram-2m", "psram"]
+psram-2m = ["esp-hal/psram-2m", "psram"]
 ## Use externally connected PSRAM (4MB).
-psram-4m = ["esp-hal-common/psram-4m", "psram"]
+psram-4m = ["esp-hal/psram-4m", "psram"]
 ## Use externally connected PSRAM (8MB).
-psram-8m = ["esp-hal-common/psram-8m", "psram"]
+psram-8m = ["esp-hal/psram-8m", "psram"]
 
 #! ### Embassy Feature Flags
 ## Enable support for `embassy`, a modern asynchronous embedded framework.
-embassy = ["esp-hal-common/embassy"]
+embassy = ["esp-hal/embassy"]
 ## Use the interrupt-mode embassy executor.
-embassy-executor-interrupt = ["esp-hal-common/embassy-executor-interrupt"]
+embassy-executor-interrupt = ["esp-hal/embassy-executor-interrupt"]
 ## Use the thread-mode embassy executor.
-embassy-executor-thread = ["esp-hal-common/embassy-executor-thread"]
+embassy-executor-thread = ["esp-hal/embassy-executor-thread"]
 ## Uses hardware timers as alarms for the executors. Using this feature
 ## limits the number of executors to the number of hardware alarms provided
 ## by the time driver.
-embassy-integrated-timers = ["esp-hal-common/embassy-integrated-timers"]
+embassy-integrated-timers = ["esp-hal/embassy-integrated-timers"]
 ## Enable the embassy time driver using the `TIMG0` peripheral. The `TIMG0`
 ## peripheral has two alarms available for use.
-embassy-time-timg0 = ["esp-hal-common/embassy-time-timg0", "embassy-time-driver/tick-hz-1_000_000"]
+embassy-time-timg0 = ["esp-hal/embassy-time-timg0", "embassy-time-driver/tick-hz-1_000_000"]
 
 [profile.release]
 debug = true

esp32-hal/src/lib.rs

@@ -6,4 +6,4 @@
 #![doc(html_logo_url = "https://avatars.githubusercontent.com/u/46717278")]
 #![no_std]
 
-pub use esp_hal_common::*;
+pub use esp_hal::*;

esp32c2-hal/Cargo.toml

@@ -25,7 +25,7 @@ targets = ["riscv32imc-unknown-none-elf"]
 
 [dependencies]
 document-features   = "0.2.7"
-esp-hal-common      = { version = "0.15.0", features = ["esp32c2"], path = "../esp-hal-common" }
+esp-hal             = { version = "0.15.0", features = ["esp32c2"], path = "../esp-hal" }
 embassy-time-driver = { version = "0.1.0",  optional = true }
 
 [dev-dependencies]
@@ -55,53 +55,53 @@ static_cell        = { version = "2.0.0", features = ["nightly"] }
 default = ["embassy-integrated-timers", "rt", "vectored", "xtal-40mhz"]
 
 ## Enable debug features in the HAL (used for development).
-debug = ["esp-hal-common/debug"]
+debug = ["esp-hal/debug"]
 ## Enable direct interrupt vectoring.
-direct-vectoring = ["esp-hal-common/direct-vectoring"]
+direct-vectoring = ["esp-hal/direct-vectoring"]
 ## Enable interrupt preemption.
-interrupt-preemption = ["esp-hal-common/interrupt-preemption"]
+interrupt-preemption = ["esp-hal/interrupt-preemption"]
 ## Enable logging output using the `log` crate.
-log = ["esp-hal-common/log", "esp-println/log"]
+log = ["esp-hal/log", "esp-println/log"]
 ## Enable runtime support.
-rt = ["esp-hal-common/rt-riscv"]
+rt = ["esp-hal/rt-riscv"]
 ## Enable interrupt vectoring.
-vectored = ["esp-hal-common/vectored"]
+vectored = ["esp-hal/vectored"]
 ## Target device has a 26MHz crystal.
-xtal-26mhz = ["esp-hal-common/xtal-26mhz"]
+xtal-26mhz = ["esp-hal/xtal-26mhz"]
 ## Target device has a 40MHz crystal.
-xtal-40mhz = ["esp-hal-common/xtal-40mhz"]
+xtal-40mhz = ["esp-hal/xtal-40mhz"]
 
 #! ### Trait Implementation Feature Flags
 ## Enable support for asynchronous operation, with interfaces provided by
 ## `embedded-hal-async` and `embedded-io-async`.
-async = ["esp-hal-common/async"]
+async = ["esp-hal/async"]
 ## Implement `defmt::Format` on certain types.
-defmt = ["esp-hal-common/defmt", "esp-println/defmt-espflash"]
+defmt = ["esp-hal/defmt", "esp-println/defmt-espflash"]
 ## Implement the traits defined in the `1.0.0` releases of `embedded-hal` and
 ## `embedded-hal-nb` for the relevant peripherals.
-eh1 = ["esp-hal-common/eh1"]
+eh1 = ["esp-hal/eh1"]
 ## Implement the traits defined in `embedded-io` for certain peripherals.
-embedded-io = ["esp-hal-common/embedded-io"]
+embedded-io = ["esp-hal/embedded-io"]
 ## Implement the `ufmt_write::uWrite` trait for certain peripherals.
-ufmt = ["esp-hal-common/ufmt"]
+ufmt = ["esp-hal/ufmt"]
 
 #! ### Embassy Feature Flags
 ## Enable support for `embassy`, a modern asynchronous embedded framework.
-embassy = ["esp-hal-common/embassy"]
+embassy = ["esp-hal/embassy"]
 ## Use the interrupt-mode embassy executor.
-embassy-executor-interrupt = ["esp-hal-common/embassy-executor-interrupt"]
+embassy-executor-interrupt = ["esp-hal/embassy-executor-interrupt"]
 ## Use the thread-mode embassy executor.
-embassy-executor-thread = ["esp-hal-common/embassy-executor-thread"]
+embassy-executor-thread = ["esp-hal/embassy-executor-thread"]
 ## Uses hardware timers as alarms for the executors. Using this feature
 ## limits the number of executors to the number of hardware alarms provided
 ## by the time driver.
-embassy-integrated-timers = ["esp-hal-common/embassy-integrated-timers"]
+embassy-integrated-timers = ["esp-hal/embassy-integrated-timers"]
 ## Enable the embassy time driver using the `SYSTIMER` peripheral. The
 ## `SYSTIMER` peripheral has three alarams available for use.
-embassy-time-systick = ["esp-hal-common/embassy-time-systick", "embassy-time-driver/tick-hz-16_000_000"]
+embassy-time-systick = ["esp-hal/embassy-time-systick", "embassy-time-driver/tick-hz-16_000_000"]
 ## Enable the embassy time driver using the `TIMG0` peripheral. The `TIMG0`
 ## peripheral has two alarms available for use.
-embassy-time-timg0 = ["esp-hal-common/embassy-time-timg0", "embassy-time-driver/tick-hz-1_000_000"]
+embassy-time-timg0 = ["esp-hal/embassy-time-timg0", "embassy-time-driver/tick-hz-1_000_000"]
 
 [profile.release]
 debug = true

esp32c2-hal/src/lib.rs

@@ -6,4 +6,4 @@
 #![doc(html_logo_url = "https://avatars.githubusercontent.com/u/46717278")]
 #![no_std]
 
-pub use esp_hal_common::*;
+pub use esp_hal::*;

esp32c3-hal/Cargo.toml

@@ -25,7 +25,7 @@ targets = ["riscv32imc-unknown-none-elf"]
 
 [dependencies]
 document-features   = "0.2.7"
-esp-hal-common      = { version = "0.15.0", features = ["esp32c3"], path = "../esp-hal-common" }
+esp-hal             = { version = "0.15.0", features = ["esp32c3"], path = "../esp-hal" }
 embassy-time-driver = { version = "0.1.0",  optional = true }
 
 [dev-dependencies]
@@ -57,57 +57,57 @@ static_cell        = { version = "2.0.0", features = ["nightly"] }
 default = ["embassy-integrated-timers", "rt", "vectored", "zero-rtc-bss"]
 
 ## Enable debug features in the HAL (used for development).
-debug = ["esp-hal-common/debug"]
+debug = ["esp-hal/debug"]
 ## Enable direct interrupt vectoring.
-direct-vectoring = ["esp-hal-common/direct-vectoring"]
+direct-vectoring = ["esp-hal/direct-vectoring"]
 ## Enable interrupt preemption.
-interrupt-preemption = ["esp-hal-common/interrupt-preemption"]
+interrupt-preemption = ["esp-hal/interrupt-preemption"]
 ## Enable logging output using the `log` crate.
-log = ["esp-hal-common/log", "esp-println/log"]
+log = ["esp-hal/log", "esp-println/log"]
 ## Enable runtime support.
-rt = ["esp-hal-common/rt-riscv"]
+rt = ["esp-hal/rt-riscv"]
 ## Enable interrupt vectoring.
-vectored = ["esp-hal-common/vectored"]
+vectored = ["esp-hal/vectored"]
 
 #! ### Trait Implementation Feature Flags
 ## Enable support for asynchronous operation, with interfaces provided by
 ## `embedded-hal-async` and `embedded-io-async`.
-async = ["esp-hal-common/async"]
+async = ["esp-hal/async"]
 ## Implement `defmt::Format` on certain types.
-defmt = ["esp-hal-common/defmt", "esp-println/defmt-espflash"]
+defmt = ["esp-hal/defmt", "esp-println/defmt-espflash"]
 ## Implement the traits defined in the `1.0.0` releases of `embedded-hal` and
 ## `embedded-hal-nb` for the relevant peripherals.
-eh1 = ["esp-hal-common/eh1"]
+eh1 = ["esp-hal/eh1"]
 ## Implement the traits defined in `embedded-io` for certain peripherals.
-embedded-io = ["esp-hal-common/embedded-io"]
+embedded-io = ["esp-hal/embedded-io"]
 ## Implement the `ufmt_write::uWrite` trait for certain peripherals.
-ufmt = ["esp-hal-common/ufmt"]
+ufmt = ["esp-hal/ufmt"]
 
 #! ### Memory Initialization Feature Flags
 ## Zero the `.bss` section of low-power memory.
-zero-rtc-bss = ["esp-hal-common/rv-zero-rtc-bss"]
+zero-rtc-bss = ["esp-hal/rv-zero-rtc-bss"]
 ## Initialize the `.data` section of memory.
-init-data = ["esp-hal-common/rv-init-data"]
+init-data = ["esp-hal/rv-init-data"]
 ## Initialize the `.data` section of low-power memory.
-init-rtc-data = ["esp-hal-common/rv-init-rtc-data"]
+init-rtc-data = ["esp-hal/rv-init-rtc-data"]
 
 #! ### Embassy Feature Flags
 ## Enable support for `embassy`, a modern asynchronous embedded framework.
-embassy = ["esp-hal-common/embassy"]
+embassy = ["esp-hal/embassy"]
 ## Use the interrupt-mode embassy executor.
-embassy-executor-interrupt = ["esp-hal-common/embassy-executor-interrupt"]
+embassy-executor-interrupt = ["esp-hal/embassy-executor-interrupt"]
 ## Use the thread-mode embassy executor.
-embassy-executor-thread = ["esp-hal-common/embassy-executor-thread"]
+embassy-executor-thread = ["esp-hal/embassy-executor-thread"]
 ## Uses hardware timers as alarms for the executors. Using this feature
 ## limits the number of executors to the number of hardware alarms provided
 ## by the time driver.
-embassy-integrated-timers = ["esp-hal-common/embassy-integrated-timers"]
+embassy-integrated-timers = ["esp-hal/embassy-integrated-timers"]
 ## Enable the embassy time driver using the `SYSTIMER` peripheral. The
 ## `SYSTIMER` peripheral has three alarams available for use.
-embassy-time-systick = ["esp-hal-common/embassy-time-systick", "embassy-time-driver/tick-hz-16_000_000"]
+embassy-time-systick = ["esp-hal/embassy-time-systick", "embassy-time-driver/tick-hz-16_000_000"]
 ## Enable the embassy time driver using the `TIMG0` peripheral. The `TIMG0`
 ## peripheral has two alarms available for use.
-embassy-time-timg0 = ["esp-hal-common/embassy-time-timg0", "embassy-time-driver/tick-hz-1_000_000"]
+embassy-time-timg0 = ["esp-hal/embassy-time-timg0", "embassy-time-driver/tick-hz-1_000_000"]
 
 [profile.release]
 debug = true

esp32c3-hal/examples/embassy_usb_serial_jtag.rs

@@ -17,7 +17,7 @@ use esp32c3_hal::{
     UsbSerialJtag,
 };
 use esp_backtrace as _;
-use esp_hal_common::usb_serial_jtag::{UsbSerialJtagRx, UsbSerialJtagTx};
+use esp_hal::usb_serial_jtag::{UsbSerialJtagRx, UsbSerialJtagTx};
 use static_cell::make_static;
 
 const MAX_BUFFER_SIZE: usize = 512;