aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--embassy-rp/src/adc.rs210
-rw-r--r--embassy-rp/src/lib.rs1
-rw-r--r--examples/rp/src/bin/adc.rs11
-rw-r--r--tests/rp/src/bin/adc.rs73
4 files changed, 222 insertions, 73 deletions
diff --git a/embassy-rp/src/adc.rs b/embassy-rp/src/adc.rs
index 4fba31169..bac455743 100644
--- a/embassy-rp/src/adc.rs
+++ b/embassy-rp/src/adc.rs
@@ -1,5 +1,6 @@
1use core::future::poll_fn; 1use core::future::poll_fn;
2use core::marker::PhantomData; 2use core::marker::PhantomData;
3use core::mem;
3use core::sync::atomic::{compiler_fence, Ordering}; 4use core::sync::atomic::{compiler_fence, Ordering};
4use core::task::Poll; 5use core::task::Poll;
5 6
@@ -10,8 +11,8 @@ use crate::gpio::sealed::Pin as GpioPin;
10use crate::gpio::{self, AnyPin, Pull}; 11use crate::gpio::{self, AnyPin, Pull};
11use crate::interrupt::typelevel::Binding; 12use crate::interrupt::typelevel::Binding;
12use crate::interrupt::InterruptExt; 13use crate::interrupt::InterruptExt;
13use crate::peripherals::ADC; 14use crate::peripherals::{ADC, ADC_TEMP_SENSOR};
14use crate::{interrupt, pac, peripherals, Peripheral}; 15use crate::{dma, interrupt, pac, peripherals, Peripheral, RegExt};
15 16
16static WAKER: AtomicWaker = AtomicWaker::new(); 17static WAKER: AtomicWaker = AtomicWaker::new();
17 18
@@ -24,12 +25,15 @@ impl Default for Config {
24 } 25 }
25} 26}
26 27
27pub struct Pin<'p> { 28enum Source<'p> {
28 pin: PeripheralRef<'p, AnyPin>, 29 Pin(PeripheralRef<'p, AnyPin>),
30 TempSensor(PeripheralRef<'p, ADC_TEMP_SENSOR>),
29} 31}
30 32
31impl<'p> Pin<'p> { 33pub struct Channel<'p>(Source<'p>);
32 pub fn new(pin: impl Peripheral<P = impl AdcPin + 'p> + 'p, pull: Pull) -> Self { 34
35impl<'p> Channel<'p> {
36 pub fn new_pin(pin: impl Peripheral<P = impl AdcPin + 'p> + 'p, pull: Pull) -> Self {
33 into_ref!(pin); 37 into_ref!(pin);
34 pin.pad_ctrl().modify(|w| { 38 pin.pad_ctrl().modify(|w| {
35 // manual says: 39 // manual says:
@@ -42,24 +46,55 @@ impl<'p> Pin<'p> {
42 w.set_pue(pull == Pull::Up); 46 w.set_pue(pull == Pull::Up);
43 w.set_pde(pull == Pull::Down); 47 w.set_pde(pull == Pull::Down);
44 }); 48 });
45 Self { pin: pin.map_into() } 49 Self(Source::Pin(pin.map_into()))
50 }
51
52 pub fn new_temp_sensor(s: impl Peripheral<P = ADC_TEMP_SENSOR> + 'p) -> Self {
53 let r = pac::ADC;
54 r.cs().write_set(|w| w.set_ts_en(true));
55 Self(Source::TempSensor(s.into_ref()))
46 } 56 }
47 57
48 fn channel(&self) -> u8 { 58 fn channel(&self) -> u8 {
49 // this requires adc pins to be sequential and matching the adc channels, 59 match &self.0 {
50 // which is the case for rp2040 60 // this requires adc pins to be sequential and matching the adc channels,
51 self.pin._pin() - 26 61 // which is the case for rp2040
62 Source::Pin(p) => p._pin() - 26,
63 Source::TempSensor(_) => 4,
64 }
52 } 65 }
53} 66}
54 67
55impl<'d> Drop for Pin<'d> { 68impl<'p> Drop for Source<'p> {
56 fn drop(&mut self) { 69 fn drop(&mut self) {
57 self.pin.pad_ctrl().modify(|w| { 70 match self {
58 w.set_ie(true); 71 Source::Pin(p) => {
59 w.set_od(false); 72 p.pad_ctrl().modify(|w| {
60 w.set_pue(false); 73 w.set_ie(true);
61 w.set_pde(true); 74 w.set_od(false);
62 }); 75 w.set_pue(false);
76 w.set_pde(true);
77 });
78 }
79 Source::TempSensor(_) => {
80 pac::ADC.cs().write_clear(|w| w.set_ts_en(true));
81 }
82 }
83 }
84}
85
86#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Default)]
87#[cfg_attr(feature = "defmt", derive(defmt::Format))]
88#[repr(transparent)]
89pub struct Sample(u16);
90
91impl Sample {
92 pub fn good(&self) -> bool {
93 self.0 < 0x8000
94 }
95
96 pub fn value(&self) -> u16 {
97 self.0 & !0x8000
63 } 98 }
64} 99}
65 100
@@ -115,10 +150,10 @@ impl<'d, M: Mode> Adc<'d, M> {
115 while !r.cs().read().ready() {} 150 while !r.cs().read().ready() {}
116 } 151 }
117 152
118 fn sample_blocking(channel: u8) -> Result<u16, Error> { 153 pub fn blocking_read(&mut self, ch: &mut Channel) -> Result<u16, Error> {
119 let r = Self::regs(); 154 let r = Self::regs();
120 r.cs().modify(|w| { 155 r.cs().modify(|w| {
121 w.set_ainsel(channel); 156 w.set_ainsel(ch.channel());
122 w.set_start_once(true); 157 w.set_start_once(true);
123 w.set_err(true); 158 w.set_err(true);
124 }); 159 });
@@ -128,19 +163,6 @@ impl<'d, M: Mode> Adc<'d, M> {
128 false => Ok(r.result().read().result().into()), 163 false => Ok(r.result().read().result().into()),
129 } 164 }
130 } 165 }
131
132 pub fn blocking_read(&mut self, pin: &mut Pin) -> Result<u16, Error> {
133 Self::sample_blocking(pin.channel())
134 }
135
136 pub fn blocking_read_temperature(&mut self) -> Result<u16, Error> {
137 let r = Self::regs();
138 r.cs().modify(|w| w.set_ts_en(true));
139 while !r.cs().read().ready() {}
140 let result = Self::sample_blocking(4);
141 r.cs().modify(|w| w.set_ts_en(false));
142 result
143 }
144} 166}
145 167
146impl<'d> Adc<'d, Async> { 168impl<'d> Adc<'d, Async> {
@@ -172,10 +194,10 @@ impl<'d> Adc<'d, Async> {
172 .await; 194 .await;
173 } 195 }
174 196
175 async fn sample_async(channel: u8) -> Result<u16, Error> { 197 pub async fn read(&mut self, ch: &mut Channel<'_>) -> Result<u16, Error> {
176 let r = Self::regs(); 198 let r = Self::regs();
177 r.cs().modify(|w| { 199 r.cs().modify(|w| {
178 w.set_ainsel(channel); 200 w.set_ainsel(ch.channel());
179 w.set_start_once(true); 201 w.set_start_once(true);
180 w.set_err(true); 202 w.set_err(true);
181 }); 203 });
@@ -186,19 +208,89 @@ impl<'d> Adc<'d, Async> {
186 } 208 }
187 } 209 }
188 210
189 pub async fn read(&mut self, pin: &mut Pin<'_>) -> Result<u16, Error> { 211 async fn read_many_inner<W: dma::Word>(
190 Self::sample_async(pin.channel()).await 212 &mut self,
191 } 213 ch: &mut Channel<'_>,
192 214 buf: &mut [W],
193 pub async fn read_temperature(&mut self) -> Result<u16, Error> { 215 fcs_err: bool,
216 dma: impl Peripheral<P = impl dma::Channel>,
217 ) -> Result<(), Error> {
194 let r = Self::regs(); 218 let r = Self::regs();
195 r.cs().modify(|w| w.set_ts_en(true)); 219 // clear previous errors and set channel
196 if !r.cs().read().ready() { 220 r.cs().modify(|w| {
197 Self::wait_for_ready().await; 221 w.set_ainsel(ch.channel());
222 w.set_err_sticky(true); // clear previous errors
223 w.set_start_many(false);
224 });
225 // wait for previous conversions and drain fifo. an earlier batch read may have
226 // been cancelled, leaving the adc running.
227 while !r.cs().read().ready() {}
228 while !r.fcs().read().empty() {
229 r.fifo().read();
230 }
231
232 // set up fifo for dma
233 r.fcs().write(|w| {
234 w.set_thresh(1);
235 w.set_dreq_en(true);
236 w.set_shift(mem::size_of::<W>() == 1);
237 w.set_en(true);
238 w.set_err(fcs_err);
239 });
240
241 // reset dma config on drop, regardless of whether it was a future being cancelled
242 // or the method returning normally.
243 struct ResetDmaConfig;
244 impl Drop for ResetDmaConfig {
245 fn drop(&mut self) {
246 pac::ADC.cs().write_clear(|w| w.set_start_many(true));
247 while !pac::ADC.cs().read().ready() {}
248 pac::ADC.fcs().write_clear(|w| {
249 w.set_dreq_en(true);
250 w.set_shift(true);
251 w.set_en(true);
252 });
253 }
254 }
255 let auto_reset = ResetDmaConfig;
256
257 let dma = unsafe { dma::read(dma, r.fifo().as_ptr() as *const W, buf as *mut [W], 36) };
258 // start conversions and wait for dma to finish. we can't report errors early
259 // because there's no interrupt to signal them, and inspecting every element
260 // of the fifo is too costly to do here.
261 r.cs().write_set(|w| w.set_start_many(true));
262 dma.await;
263 mem::drop(auto_reset);
264 // we can't report errors before the conversions have ended since no interrupt
265 // exists to report them early, and since they're exceedingly rare we probably don't
266 // want to anyway.
267 match r.cs().read().err_sticky() {
268 false => Ok(()),
269 true => Err(Error::ConversionFailed),
198 } 270 }
199 let result = Self::sample_async(4).await; 271 }
200 r.cs().modify(|w| w.set_ts_en(false)); 272
201 result 273 #[inline]
274 pub async fn read_many<S: AdcSample>(
275 &mut self,
276 ch: &mut Channel<'_>,
277 buf: &mut [S],
278 dma: impl Peripheral<P = impl dma::Channel>,
279 ) -> Result<(), Error> {
280 self.read_many_inner(ch, buf, false, dma).await
281 }
282
283 #[inline]
284 pub async fn read_many_raw(
285 &mut self,
286 ch: &mut Channel<'_>,
287 buf: &mut [Sample],
288 dma: impl Peripheral<P = impl dma::Channel>,
289 ) {
290 // errors are reported in individual samples
291 let _ = self
292 .read_many_inner(ch, unsafe { mem::transmute::<_, &mut [u16]>(buf) }, true, dma)
293 .await;
202 } 294 }
203} 295}
204 296
@@ -223,21 +315,26 @@ impl interrupt::typelevel::Handler<interrupt::typelevel::ADC_IRQ_FIFO> for Inter
223} 315}
224 316
225mod sealed { 317mod sealed {
226 pub trait AdcPin: crate::gpio::sealed::Pin { 318 pub trait AdcSample: crate::dma::Word {}
227 fn channel(&mut self) -> u8; 319
228 } 320 pub trait AdcChannel {}
229} 321}
230 322
231pub trait AdcPin: sealed::AdcPin + gpio::Pin {} 323pub trait AdcSample: sealed::AdcSample {}
324
325impl sealed::AdcSample for u16 {}
326impl AdcSample for u16 {}
327
328impl sealed::AdcSample for u8 {}
329impl AdcSample for u8 {}
330
331pub trait AdcChannel: sealed::AdcChannel {}
332pub trait AdcPin: AdcChannel + gpio::Pin {}
232 333
233macro_rules! impl_pin { 334macro_rules! impl_pin {
234 ($pin:ident, $channel:expr) => { 335 ($pin:ident, $channel:expr) => {
235 impl sealed::AdcPin for peripherals::$pin { 336 impl sealed::AdcChannel for peripherals::$pin {}
236 fn channel(&mut self) -> u8 { 337 impl AdcChannel for peripherals::$pin {}
237 $channel
238 }
239 }
240
241 impl AdcPin for peripherals::$pin {} 338 impl AdcPin for peripherals::$pin {}
242 }; 339 };
243} 340}
@@ -246,3 +343,6 @@ impl_pin!(PIN_26, 0);
246impl_pin!(PIN_27, 1); 343impl_pin!(PIN_27, 1);
247impl_pin!(PIN_28, 2); 344impl_pin!(PIN_28, 2);
248impl_pin!(PIN_29, 3); 345impl_pin!(PIN_29, 3);
346
347impl sealed::AdcChannel for peripherals::ADC_TEMP_SENSOR {}
348impl AdcChannel for peripherals::ADC_TEMP_SENSOR {}
diff --git a/embassy-rp/src/lib.rs b/embassy-rp/src/lib.rs
index 45156458d..49bd3533e 100644
--- a/embassy-rp/src/lib.rs
+++ b/embassy-rp/src/lib.rs
@@ -183,6 +183,7 @@ embassy_hal_internal::peripherals! {
183 FLASH, 183 FLASH,
184 184
185 ADC, 185 ADC,
186 ADC_TEMP_SENSOR,
186 187
187 CORE1, 188 CORE1,
188 189
diff --git a/examples/rp/src/bin/adc.rs b/examples/rp/src/bin/adc.rs
index 81a8b8340..02bc493b6 100644
--- a/examples/rp/src/bin/adc.rs
+++ b/examples/rp/src/bin/adc.rs
@@ -7,7 +7,7 @@
7 7
8use defmt::*; 8use defmt::*;
9use embassy_executor::Spawner; 9use embassy_executor::Spawner;
10use embassy_rp::adc::{Adc, Config, InterruptHandler, Pin}; 10use embassy_rp::adc::{Adc, Channel, Config, InterruptHandler};
11use embassy_rp::bind_interrupts; 11use embassy_rp::bind_interrupts;
12use embassy_rp::gpio::Pull; 12use embassy_rp::gpio::Pull;
13use embassy_time::{Duration, Timer}; 13use embassy_time::{Duration, Timer};
@@ -22,9 +22,10 @@ async fn main(_spawner: Spawner) {
22 let p = embassy_rp::init(Default::default()); 22 let p = embassy_rp::init(Default::default());
23 let mut adc = Adc::new(p.ADC, Irqs, Config::default()); 23 let mut adc = Adc::new(p.ADC, Irqs, Config::default());
24 24
25 let mut p26 = Pin::new(p.PIN_26, Pull::None); 25 let mut p26 = Channel::new_pin(p.PIN_26, Pull::None);
26 let mut p27 = Pin::new(p.PIN_27, Pull::None); 26 let mut p27 = Channel::new_pin(p.PIN_27, Pull::None);
27 let mut p28 = Pin::new(p.PIN_28, Pull::None); 27 let mut p28 = Channel::new_pin(p.PIN_28, Pull::None);
28 let mut ts = Channel::new_temp_sensor(p.ADC_TEMP_SENSOR);
28 29
29 loop { 30 loop {
30 let level = adc.read(&mut p26).await.unwrap(); 31 let level = adc.read(&mut p26).await.unwrap();
@@ -33,7 +34,7 @@ async fn main(_spawner: Spawner) {
33 info!("Pin 27 ADC: {}", level); 34 info!("Pin 27 ADC: {}", level);
34 let level = adc.read(&mut p28).await.unwrap(); 35 let level = adc.read(&mut p28).await.unwrap();
35 info!("Pin 28 ADC: {}", level); 36 info!("Pin 28 ADC: {}", level);
36 let temp = adc.read_temperature().await.unwrap(); 37 let temp = adc.read(&mut ts).await.unwrap();
37 info!("Temp: {} degrees", convert_to_celsius(temp)); 38 info!("Temp: {} degrees", convert_to_celsius(temp));
38 Timer::after(Duration::from_secs(1)).await; 39 Timer::after(Duration::from_secs(1)).await;
39 } 40 }
diff --git a/tests/rp/src/bin/adc.rs b/tests/rp/src/bin/adc.rs
index e659844ae..d6d58f0c0 100644
--- a/tests/rp/src/bin/adc.rs
+++ b/tests/rp/src/bin/adc.rs
@@ -6,7 +6,7 @@ mod common;
6 6
7use defmt::*; 7use defmt::*;
8use embassy_executor::Spawner; 8use embassy_executor::Spawner;
9use embassy_rp::adc::{Adc, Config, InterruptHandler, Pin}; 9use embassy_rp::adc::{Adc, Channel, Config, InterruptHandler, Sample};
10use embassy_rp::bind_interrupts; 10use embassy_rp::bind_interrupts;
11use embassy_rp::gpio::Pull; 11use embassy_rp::gpio::Pull;
12use {defmt_rtt as _, panic_probe as _}; 12use {defmt_rtt as _, panic_probe as _};
@@ -22,12 +22,12 @@ async fn main(_spawner: Spawner) {
22 22
23 { 23 {
24 { 24 {
25 let mut p = Pin::new(&mut p.PIN_26, Pull::Down); 25 let mut p = Channel::new_pin(&mut p.PIN_26, Pull::Down);
26 defmt::assert!(adc.blocking_read(&mut p).unwrap() < 0b01_0000_0000); 26 defmt::assert!(adc.blocking_read(&mut p).unwrap() < 0b01_0000_0000);
27 defmt::assert!(adc.read(&mut p).await.unwrap() < 0b01_0000_0000); 27 defmt::assert!(adc.read(&mut p).await.unwrap() < 0b01_0000_0000);
28 } 28 }
29 { 29 {
30 let mut p = Pin::new(&mut p.PIN_26, Pull::Up); 30 let mut p = Channel::new_pin(&mut p.PIN_26, Pull::Up);
31 defmt::assert!(adc.blocking_read(&mut p).unwrap() > 0b11_0000_0000); 31 defmt::assert!(adc.blocking_read(&mut p).unwrap() > 0b11_0000_0000);
32 defmt::assert!(adc.read(&mut p).await.unwrap() > 0b11_0000_0000); 32 defmt::assert!(adc.read(&mut p).await.unwrap() > 0b11_0000_0000);
33 } 33 }
@@ -35,21 +35,21 @@ async fn main(_spawner: Spawner) {
35 // not bothering with async reads from now on 35 // not bothering with async reads from now on
36 { 36 {
37 { 37 {
38 let mut p = Pin::new(&mut p.PIN_27, Pull::Down); 38 let mut p = Channel::new_pin(&mut p.PIN_27, Pull::Down);
39 defmt::assert!(adc.blocking_read(&mut p).unwrap() < 0b01_0000_0000); 39 defmt::assert!(adc.blocking_read(&mut p).unwrap() < 0b01_0000_0000);
40 } 40 }
41 { 41 {
42 let mut p = Pin::new(&mut p.PIN_27, Pull::Up); 42 let mut p = Channel::new_pin(&mut p.PIN_27, Pull::Up);
43 defmt::assert!(adc.blocking_read(&mut p).unwrap() > 0b11_0000_0000); 43 defmt::assert!(adc.blocking_read(&mut p).unwrap() > 0b11_0000_0000);
44 } 44 }
45 } 45 }
46 { 46 {
47 { 47 {
48 let mut p = Pin::new(&mut p.PIN_28, Pull::Down); 48 let mut p = Channel::new_pin(&mut p.PIN_28, Pull::Down);
49 defmt::assert!(adc.blocking_read(&mut p).unwrap() < 0b01_0000_0000); 49 defmt::assert!(adc.blocking_read(&mut p).unwrap() < 0b01_0000_0000);
50 } 50 }
51 { 51 {
52 let mut p = Pin::new(&mut p.PIN_28, Pull::Up); 52 let mut p = Channel::new_pin(&mut p.PIN_28, Pull::Up);
53 defmt::assert!(adc.blocking_read(&mut p).unwrap() > 0b11_0000_0000); 53 defmt::assert!(adc.blocking_read(&mut p).unwrap() > 0b11_0000_0000);
54 } 54 }
55 } 55 }
@@ -57,24 +57,71 @@ async fn main(_spawner: Spawner) {
57 // gp29 is connected to vsys through a 200k/100k divider, 57 // gp29 is connected to vsys through a 200k/100k divider,
58 // adding pulls should change the value 58 // adding pulls should change the value
59 let low = { 59 let low = {
60 let mut p = Pin::new(&mut p.PIN_29, Pull::Down); 60 let mut p = Channel::new_pin(&mut p.PIN_29, Pull::Down);
61 adc.blocking_read(&mut p).unwrap() 61 adc.blocking_read(&mut p).unwrap()
62 }; 62 };
63 let none = { 63 let none = {
64 let mut p = Pin::new(&mut p.PIN_29, Pull::None); 64 let mut p = Channel::new_pin(&mut p.PIN_29, Pull::None);
65 adc.blocking_read(&mut p).unwrap() 65 adc.blocking_read(&mut p).unwrap()
66 }; 66 };
67 let up = { 67 let up = {
68 let mut p = Pin::new(&mut p.PIN_29, Pull::Up); 68 let mut p = Channel::new_pin(&mut p.PIN_29, Pull::Up);
69 adc.blocking_read(&mut p).unwrap() 69 adc.blocking_read(&mut p).unwrap()
70 }; 70 };
71 defmt::assert!(low < none); 71 defmt::assert!(low < none);
72 defmt::assert!(none < up); 72 defmt::assert!(none < up);
73 } 73 }
74 {
75 let temp = convert_to_celsius(
76 adc.read(&mut Channel::new_temp_sensor(&mut p.ADC_TEMP_SENSOR))
77 .await
78 .unwrap(),
79 );
80 defmt::assert!(temp > 0.0);
81 defmt::assert!(temp < 60.0);
82 }
74 83
75 let temp = convert_to_celsius(adc.read_temperature().await.unwrap()); 84 // run a bunch of conversions. we'll only check gp29 and the temp
76 defmt::assert!(temp > 0.0); 85 // sensor here for brevity, if those two work the rest will too.
77 defmt::assert!(temp < 60.0); 86 {
87 // gp29 is connected to vsys through a 200k/100k divider,
88 // adding pulls should change the value
89 let mut low = [0u16; 16];
90 let mut none = [0u8; 16];
91 let mut up = [Sample::default(); 16];
92 adc.read_many(
93 &mut Channel::new_pin(&mut p.PIN_29, Pull::Down),
94 &mut low,
95 &mut p.DMA_CH0,
96 )
97 .await
98 .unwrap();
99 adc.read_many(
100 &mut Channel::new_pin(&mut p.PIN_29, Pull::None),
101 &mut none,
102 &mut p.DMA_CH0,
103 )
104 .await
105 .unwrap();
106 adc.read_many_raw(&mut Channel::new_pin(&mut p.PIN_29, Pull::Up), &mut up, &mut p.DMA_CH0)
107 .await;
108 defmt::assert!(low.iter().zip(none.iter()).all(|(l, n)| *l >> 4 < *n as u16));
109 defmt::assert!(up.iter().all(|s| s.good()));
110 defmt::assert!(none.iter().zip(up.iter()).all(|(n, u)| (*n as u16) < u.value()));
111 }
112 {
113 let mut temp = [0u16; 16];
114 adc.read_many(
115 &mut Channel::new_temp_sensor(&mut p.ADC_TEMP_SENSOR),
116 &mut temp,
117 &mut p.DMA_CH0,
118 )
119 .await
120 .unwrap();
121 let temp = temp.map(convert_to_celsius);
122 defmt::assert!(temp.iter().all(|t| *t > 0.0));
123 defmt::assert!(temp.iter().all(|t| *t < 60.0));
124 }
78 125
79 info!("Test OK"); 126 info!("Test OK");
80 cortex_m::asm::bkpt(); 127 cortex_m::asm::bkpt();