From 47ffb3a8f76a5c46fb33ddf06b0d34a43007798b Mon Sep 17 00:00:00 2001
From: Justin Beaurivage <justin@wearableavionics.com>
Date: Tue, 23 Jan 2024 16:26:06 -0500
Subject: [PATCH] Deprecate the spi_future module

---
 hal/src/sercom/mod.rs        | 5 +++++
 hal/src/sercom/spi_future.rs | 3 ++-
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/hal/src/sercom/mod.rs b/hal/src/sercom/mod.rs
index 2f08f94a412..93b753ad8cd 100644
--- a/hal/src/sercom/mod.rs
+++ b/hal/src/sercom/mod.rs
@@ -53,6 +53,11 @@ pub use pad::*;
 
 pub mod i2c;
 pub mod spi;
+
+#[deprecated(
+    since = "0.17.0",
+    note = "spi_future is deprecated and will be removed in a later version of atsamd_hal. Consider using the `async` APIs available in the `spi` module as a replacement."
+)]
 pub mod spi_future;
 pub mod uart;
 
diff --git a/hal/src/sercom/spi_future.rs b/hal/src/sercom/spi_future.rs
index aa1e70023f8..cb2d01f90b9 100644
--- a/hal/src/sercom/spi_future.rs
+++ b/hal/src/sercom/spi_future.rs
@@ -1,4 +1,3 @@
-#![allow(rustdoc::broken_intra_doc_links)]
 //! A [`Future`]-like interface for SPI transactions
 //!
 //! An [`SpiFuture`] takes ownership of an [`Spi`] `struct` and a `[u8]`-like
@@ -172,6 +171,8 @@
 //! [`Poll`]: core::task::Poll
 //! [RTIC]: https://rtic.rs/
 
+#![allow(rustdoc::broken_intra_doc_links)]
+
 use core::convert::Infallible;
 use core::task::Poll;