From 4a9ea47e6e74ba9fa28a2b3505dff0d90937014d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?D=C3=A1niel=20Buga?= <bugadani@gmail.com>
Date: Thu, 16 Jan 2025 10:18:06 +0100
Subject: [PATCH] Hide unstable singletons

---
 esp-hal/src/aes/mod.rs                 |  1 +
 esp-hal/src/parl_io.rs                 |  2 ++
 esp-hal/src/peripheral.rs              | 11 ++++++-----
 esp-hal/src/soc/esp32/cpu_control.rs   |  1 +
 esp-hal/src/soc/esp32s3/cpu_control.rs |  1 +
 5 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/esp-hal/src/aes/mod.rs b/esp-hal/src/aes/mod.rs
index 3bca9d404ce..fab417986bb 100644
--- a/esp-hal/src/aes/mod.rs
+++ b/esp-hal/src/aes/mod.rs
@@ -274,6 +274,7 @@ pub mod dma {
     }
 
     /// A DMA capable AES instance.
+    #[instability::unstable]
     pub struct AesDma<'d> {
         /// The underlying [`Aes`](super::Aes) driver
         pub aes: super::Aes<'d>,
diff --git a/esp-hal/src/parl_io.rs b/esp-hal/src/parl_io.rs
index 1fd837faf0a..825b96d795b 100644
--- a/esp-hal/src/parl_io.rs
+++ b/esp-hal/src/parl_io.rs
@@ -906,6 +906,7 @@ where
 }
 
 /// Parallel IO TX channel
+#[instability::unstable]
 pub struct ParlIoTx<'d, Dm>
 where
     Dm: DriverMode,
@@ -987,6 +988,7 @@ where
 }
 
 /// Parallel IO RX channel
+#[instability::unstable]
 pub struct ParlIoRx<'d, Dm>
 where
     Dm: DriverMode,
diff --git a/esp-hal/src/peripheral.rs b/esp-hal/src/peripheral.rs
index 328ed09de1b..ae03f40db98 100644
--- a/esp-hal/src/peripheral.rs
+++ b/esp-hal/src/peripheral.rs
@@ -273,7 +273,7 @@ mod peripheral_macros {
                     $crate::create_peripheral!($name <= $from_pac);
                 )*
                 $(
-                    $crate::create_peripheral!($unstable_name <= $unstable_from_pac);
+                    $crate::create_peripheral!(#[instability::unstable] $unstable_name <= $unstable_from_pac);
                 )*
             }
 
@@ -383,7 +383,7 @@ mod peripheral_macros {
             )*
 
             $(
-                pub use peripherals::$unstable_name;
+                pub(crate) use peripherals::$unstable_name;
                 $(
                     impl peripherals::$unstable_name {
                         $(
@@ -427,7 +427,8 @@ mod peripheral_macros {
     #[macro_export]
     /// Macro to create a peripheral structure.
     macro_rules! create_peripheral {
-        ($name:ident <= virtual) => {
+        ($(#[$attr:meta])? $name:ident <= virtual) => {
+            $(#[$attr])?
             #[derive(Debug)]
             #[cfg_attr(feature = "defmt", derive(defmt::Format))]
             #[non_exhaustive]
@@ -459,8 +460,8 @@ mod peripheral_macros {
             impl $crate::private::Sealed for $name {}
         };
 
-        ($name:ident <= $base:ident) => {
-            $crate::create_peripheral!($name <= virtual);
+        ($(#[$attr:meta])? $name:ident <= $base:ident) => {
+            $crate::create_peripheral!($(#[$attr])? $name <= virtual);
 
             impl $name {
                 #[doc = r"Pointer to the register block"]
diff --git a/esp-hal/src/soc/esp32/cpu_control.rs b/esp-hal/src/soc/esp32/cpu_control.rs
index 3d557ed163a..cbdb0a5e261 100644
--- a/esp-hal/src/soc/esp32/cpu_control.rs
+++ b/esp-hal/src/soc/esp32/cpu_control.rs
@@ -174,6 +174,7 @@ unsafe fn internal_park_core(core: Cpu) {
 
 impl<'d> CpuControl<'d> {
     /// Creates a new instance of `CpuControl`.
+    #[instability::unstable]
     pub fn new(cpu_control: impl Peripheral<P = CPU_CTRL> + 'd) -> CpuControl<'d> {
         crate::into_ref!(cpu_control);
 
diff --git a/esp-hal/src/soc/esp32s3/cpu_control.rs b/esp-hal/src/soc/esp32s3/cpu_control.rs
index f2494bf44f0..cd64bfbe75a 100644
--- a/esp-hal/src/soc/esp32s3/cpu_control.rs
+++ b/esp-hal/src/soc/esp32s3/cpu_control.rs
@@ -174,6 +174,7 @@ unsafe fn internal_park_core(core: Cpu) {
 
 impl<'d> CpuControl<'d> {
     /// Creates a new instance of `CpuControl`.
+    #[instability::unstable]
     pub fn new(cpu_control: impl Peripheral<P = CPU_CTRL> + 'd) -> CpuControl<'d> {
         crate::into_ref!(cpu_control);