Hide Interrupts

esp-rs · Feb 19, 2025 · 67906c6 · 67906c6
1 parent acbb983
commit 67906c6
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 0 deletions.
diff --git a/esp-hal/CHANGELOG.md b/esp-hal/CHANGELOG.md
@@ -72,6 +72,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The fields of config structs are no longer public (#3011)
 - Removed the dysfunctional `DmaChannel::set_priority` function (#3088)
 - `esp_hal::time::now()`, which has been replaced by `esp_hal::time::Instant::now()` (#3083)
+- `peripherals::Interrupts` (#3152)
 
 ## [0.23.1] - 2025-01-15
 

diff --git a/esp-hal/MIGRATING-0.23.md b/esp-hal/MIGRATING-0.23.md
@@ -117,6 +117,9 @@ The `_bytes` postfix of driver methods that take a byte slice have been removed.
 + uart0.write(b"Hello world!")?;
 ```
 
+The `peripherals::Interrupts` enum is no longer available. Users (mostly third party driver
+developers) will need to use the PAC crates directly.
+
 ## UART changes
 
 Uart `write` is now blocking and return the number of bytes written. `read` will block until it fills at least one byte into the buffer with received bytes, use `read_buffered_bytes` to read the available bytes without blocking.

diff --git a/esp-hal/src/soc/esp32/peripherals.rs b/esp-hal/src/soc/esp32/peripherals.rs
@@ -10,6 +10,7 @@
 
 pub(crate) use esp32 as pac;
 // We need to export this for users to use
+#[doc(hidden)]
 pub use pac::Interrupt;
 
 // Note that certain are marked with `virtual` in the invocation of the

diff --git a/esp-hal/src/soc/esp32c2/peripherals.rs b/esp-hal/src/soc/esp32c2/peripherals.rs
@@ -10,6 +10,7 @@
 
 pub(crate) use esp32c2 as pac;
 // We need to export this for users to use
+#[doc(hidden)]
 pub use pac::Interrupt;
 
 // Note that certain are marked with `virtual` in the invocation of the

diff --git a/esp-hal/src/soc/esp32c3/peripherals.rs b/esp-hal/src/soc/esp32c3/peripherals.rs
@@ -10,6 +10,7 @@
 
 pub(crate) use esp32c3 as pac;
 // We need to export this for users to use
+#[doc(hidden)]
 pub use pac::Interrupt;
 
 // Note that certain are marked with `virtual` in the invocation of the

diff --git a/esp-hal/src/soc/esp32c6/peripherals.rs b/esp-hal/src/soc/esp32c6/peripherals.rs
@@ -10,6 +10,7 @@
 
 pub(crate) use esp32c6 as pac;
 // We need to export this for users to use
+#[doc(hidden)]
 pub use pac::Interrupt;
 
 // Note that certain are marked with `virtual` in the invocation of the

diff --git a/esp-hal/src/soc/esp32h2/peripherals.rs b/esp-hal/src/soc/esp32h2/peripherals.rs
@@ -10,6 +10,7 @@
 
 pub(crate) use esp32h2 as pac;
 // We need to export this for users to use
+#[doc(hidden)]
 pub use pac::Interrupt;
 
 // Note that certain are marked with `virtual` in the invocation of the

diff --git a/esp-hal/src/soc/esp32s2/peripherals.rs b/esp-hal/src/soc/esp32s2/peripherals.rs
@@ -10,6 +10,7 @@
 
 pub(crate) use esp32s2 as pac;
 // We need to export this for users to use
+#[doc(hidden)]
 pub use pac::Interrupt;
 
 // Note that certain are marked with `virtual` in the invocation of the

diff --git a/esp-hal/src/soc/esp32s3/peripherals.rs b/esp-hal/src/soc/esp32s3/peripherals.rs
@@ -10,6 +10,7 @@
 
 pub(crate) use esp32s3 as pac;
 // We need to export this for users to use
+#[doc(hidden)]
 pub use pac::Interrupt;
 
 // Note that certain are marked with `virtual` in the invocation of the