aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--embassy-nrf/src/pwm.rs435
-rw-r--r--embassy-nrf/src/util.rs8
-rw-r--r--examples/nrf/src/bin/pwm.rs5
-rw-r--r--examples/nrf/src/bin/pwm_led.rs47
-rw-r--r--examples/nrf/src/bin/pwm_sequence.rs115
-rw-r--r--examples/nrf/src/bin/pwm_servo.rs48
6 files changed, 605 insertions, 53 deletions
diff --git a/embassy-nrf/src/pwm.rs b/embassy-nrf/src/pwm.rs
index 5e996e882..08e9add0e 100644
--- a/embassy-nrf/src/pwm.rs
+++ b/embassy-nrf/src/pwm.rs
@@ -1,16 +1,299 @@
1#![macro_use] 1#![macro_use]
2 2
3use core::cell::UnsafeCell;
4use core::marker::PhantomData; 3use core::marker::PhantomData;
5use core::sync::atomic::{compiler_fence, Ordering}; 4use core::sync::atomic::{compiler_fence, Ordering};
6use embassy::util::Unborrow; 5use embassy::util::Unborrow;
7use embassy_hal_common::unborrow; 6use embassy_hal_common::unborrow;
8 7
9use crate::gpio::sealed::Pin as _; 8use crate::gpio::sealed::Pin as _;
10use crate::gpio::OptionalPin as GpioOptionalPin; 9use crate::gpio::{AnyPin, OptionalPin as GpioOptionalPin};
11use crate::interrupt::Interrupt; 10use crate::interrupt::Interrupt;
12use crate::pac; 11use crate::pac;
12use crate::util::slice_in_ram_or;
13 13
14/// SimplePwm is the traditional pwm interface you're probably used to, allowing
15/// to simply set a duty cycle across up to four channels.
16pub struct SimplePwm<'d, T: Instance> {
17 phantom: PhantomData<&'d mut T>,
18 duty: [u16; 4],
19 ch0: Option<AnyPin>,
20 ch1: Option<AnyPin>,
21 ch2: Option<AnyPin>,
22 ch3: Option<AnyPin>,
23}
24
25/// SequencePwm allows you to offload the updating of a sequence of duty cycles
26/// to up to four channels, as well as repeat that sequence n times.
27pub struct SequencePwm<'d, T: Instance> {
28 phantom: PhantomData<&'d mut T>,
29 ch0: Option<AnyPin>,
30 ch1: Option<AnyPin>,
31 ch2: Option<AnyPin>,
32 ch3: Option<AnyPin>,
33}
34
35#[derive(Debug, Clone, Copy, PartialEq, Eq)]
36#[cfg_attr(feature = "defmt", derive(defmt::Format))]
37#[non_exhaustive]
38pub enum Error {
39 /// Max Sequence size is 32767
40 SequenceTooLong,
41 /// Min Sequence count is 1
42 SequenceTimesAtLeastOne,
43 /// EasyDMA can only read from data memory, read only buffers in flash will fail.
44 DMABufferNotInDataMemory,
45}
46
47impl<'d, T: Instance> SequencePwm<'d, T> {
48 /// Creates the interface to a `SequencePwm`.
49 ///
50 /// Must be started by calling `start`
51 ///
52 /// # Safety
53 ///
54 /// The returned API is safe unless you use `mem::forget` (or similar safe
55 /// mechanisms) on stack allocated buffers which which have been passed to
56 /// [`new()`](SequencePwm::new).
57 #[allow(unused_unsafe)]
58 pub fn new<'a>(
59 _pwm: impl Unborrow<Target = T> + 'd,
60 ch0: impl Unborrow<Target = impl GpioOptionalPin> + 'd,
61 ch1: impl Unborrow<Target = impl GpioOptionalPin> + 'd,
62 ch2: impl Unborrow<Target = impl GpioOptionalPin> + 'd,
63 ch3: impl Unborrow<Target = impl GpioOptionalPin> + 'd,
64 config: SequenceConfig,
65 sequence: &'a [u16],
66 ) -> Result<Self, Error> {
67 slice_in_ram_or(sequence, Error::DMABufferNotInDataMemory)?;
68
69 if sequence.len() > 32767 {
70 return Err(Error::SequenceTooLong);
71 }
72
73 unborrow!(ch0, ch1, ch2, ch3);
74
75 let r = T::regs();
76
77 if let Some(pin) = ch0.pin_mut() {
78 pin.set_low();
79 pin.conf().write(|w| w.dir().output());
80 }
81 if let Some(pin) = ch1.pin_mut() {
82 pin.set_low();
83 pin.conf().write(|w| w.dir().output());
84 }
85 if let Some(pin) = ch2.pin_mut() {
86 pin.set_low();
87 pin.conf().write(|w| w.dir().output());
88 }
89 if let Some(pin) = ch3.pin_mut() {
90 pin.set_low();
91 pin.conf().write(|w| w.dir().output());
92 }
93
94 // if NoPin provided writes disconnected (top bit 1) 0x80000000 else
95 // writes pin number ex 13 (0x0D) which is connected (top bit 0)
96 r.psel.out[0].write(|w| unsafe { w.bits(ch0.psel_bits()) });
97 r.psel.out[1].write(|w| unsafe { w.bits(ch1.psel_bits()) });
98 r.psel.out[2].write(|w| unsafe { w.bits(ch2.psel_bits()) });
99 r.psel.out[3].write(|w| unsafe { w.bits(ch3.psel_bits()) });
100
101 // Disable all interrupts
102 r.intenclr.write(|w| unsafe { w.bits(0xFFFF_FFFF) });
103 r.shorts.reset();
104
105 // Enable
106 r.enable.write(|w| w.enable().enabled());
107
108 r.seq0
109 .ptr
110 .write(|w| unsafe { w.bits(sequence.as_ptr() as u32) });
111 r.seq0
112 .cnt
113 .write(|w| unsafe { w.bits(sequence.len() as u32) });
114 r.seq0.refresh.write(|w| unsafe { w.bits(config.refresh) });
115 r.seq0
116 .enddelay
117 .write(|w| unsafe { w.bits(config.end_delay) });
118
119 r.seq1
120 .ptr
121 .write(|w| unsafe { w.bits(sequence.as_ptr() as u32) });
122 r.seq1
123 .cnt
124 .write(|w| unsafe { w.bits(sequence.len() as u32) });
125 r.seq1.refresh.write(|w| unsafe { w.bits(config.refresh) });
126 r.seq1
127 .enddelay
128 .write(|w| unsafe { w.bits(config.end_delay) });
129
130 r.decoder.write(|w| {
131 w.load().bits(config.sequence_load as u8);
132 w.mode().refresh_count()
133 });
134
135 r.mode.write(|w| match config.counter_mode {
136 CounterMode::UpAndDown => w.updown().up_and_down(),
137 CounterMode::Up => w.updown().up(),
138 });
139 r.prescaler
140 .write(|w| w.prescaler().bits(config.prescaler as u8));
141 r.countertop
142 .write(|w| unsafe { w.countertop().bits(config.top) });
143
144 Ok(Self {
145 phantom: PhantomData,
146 ch0: ch0.degrade_optional(),
147 ch1: ch1.degrade_optional(),
148 ch2: ch2.degrade_optional(),
149 ch3: ch3.degrade_optional(),
150 })
151 }
152
153 /// Start or restart playback
154 #[inline(always)]
155 pub fn start(&self, times: SequenceMode) -> Result<(), Error> {
156 if let SequenceMode::Times(0) = times {
157 return Err(Error::SequenceTimesAtLeastOne);
158 }
159 let r = T::regs();
160
161 self.stop();
162
163 r.enable.write(|w| w.enable().enabled());
164
165 // defensive before seqstart
166 compiler_fence(Ordering::SeqCst);
167
168 match times {
169 // just the one time, no loop count
170 SequenceMode::Times(1) => {
171 r.loop_.write(|w| w.cnt().disabled());
172 // tasks_seqstart() doesn't exist in all svds so write its bit instead
173 r.tasks_seqstart[0].write(|w| unsafe { w.bits(0x01) });
174 }
175 // loop count is how many times to play BOTH sequences
176 // 2 total (1 x 2)
177 // 3 total, (2 x 2) - 1
178 SequenceMode::Times(n) => {
179 let odd = n & 1 == 1;
180 let times = if odd { (n / 2) + 1 } else { n / 2 };
181
182 r.loop_.write(|w| unsafe { w.cnt().bits(times) });
183
184 // we can subtract 1 by starting at seq1 instead of seq0
185 if odd {
186 // tasks_seqstart() doesn't exist in all svds so write its bit instead
187 r.tasks_seqstart[1].write(|w| unsafe { w.bits(0x01) });
188 } else {
189 // tasks_seqstart() doesn't exist in all svds so write its bit instead
190 r.tasks_seqstart[0].write(|w| unsafe { w.bits(0x01) });
191 }
192 }
193 // to play infinitely, repeat the sequence one time, then have loops done self trigger seq0 again
194 SequenceMode::Infinite => {
195 r.loop_.write(|w| unsafe { w.cnt().bits(0x1) });
196 r.shorts.write(|w| w.loopsdone_seqstart0().enabled());
197
198 // tasks_seqstart() doesn't exist in all svds so write its bit instead
199 r.tasks_seqstart[0].write(|w| unsafe { w.bits(0x01) });
200 }
201 }
202
203 Ok(())
204 }
205
206 /// Stop playback.
207 #[inline(always)]
208 pub fn stop(&self) {
209 let r = T::regs();
210
211 r.shorts.reset();
212
213 compiler_fence(Ordering::SeqCst);
214
215 // tasks_stop() doesn't exist in all svds so write its bit instead
216 r.tasks_stop.write(|w| unsafe { w.bits(0x01) });
217 }
218
219 /// Disables the PWM generator.
220 #[inline(always)]
221 pub fn disable(&self) {
222 let r = T::regs();
223 r.enable.write(|w| w.enable().disabled());
224 }
225}
226
227impl<'a, T: Instance> Drop for SequencePwm<'a, T> {
228 fn drop(&mut self) {
229 let r = T::regs();
230
231 self.stop();
232 self.disable();
233
234 if let Some(pin) = &self.ch0 {
235 pin.set_low();
236 pin.conf().write(|w| w);
237 r.psel.out[0].write(|w| unsafe { w.bits(0x80000000) });
238 }
239 if let Some(pin) = &self.ch1 {
240 pin.set_low();
241 pin.conf().write(|w| w);
242 r.psel.out[1].write(|w| unsafe { w.bits(0x80000000) });
243 }
244 if let Some(pin) = &self.ch2 {
245 pin.set_low();
246 pin.conf().write(|w| w);
247 r.psel.out[2].write(|w| unsafe { w.bits(0x80000000) });
248 }
249 if let Some(pin) = &self.ch3 {
250 pin.set_low();
251 pin.conf().write(|w| w);
252 r.psel.out[3].write(|w| unsafe { w.bits(0x80000000) });
253 }
254 }
255}
256
257/// Configure an infinite looping sequence for `SequencePwm`
258#[non_exhaustive]
259pub struct SequenceConfig {
260 /// Selects up mode or up-and-down mode for the counter
261 pub counter_mode: CounterMode,
262 /// Top value to be compared against buffer values
263 pub top: u16,
264 /// Configuration for PWM_CLK
265 pub prescaler: Prescaler,
266 /// How a sequence is read from RAM and is spread to the compare register
267 pub sequence_load: SequenceLoad,
268 /// Number of PWM periods to delay between each sequence sample
269 pub refresh: u32,
270 /// Number of PWM periods after the sequence ends before starting the next sequence
271 pub end_delay: u32,
272}
273
274impl Default for SequenceConfig {
275 fn default() -> SequenceConfig {
276 SequenceConfig {
277 counter_mode: CounterMode::Up,
278 top: 1000,
279 prescaler: Prescaler::Div16,
280 sequence_load: SequenceLoad::Common,
281 refresh: 0,
282 end_delay: 0,
283 }
284 }
285}
286
287/// How many times to run the sequence
288#[derive(Debug, Eq, PartialEq, Clone, Copy)]
289pub enum SequenceMode {
290 /// Run sequence n Times total
291 Times(u16),
292 /// Repeat until `stop` is called.
293 Infinite,
294}
295
296/// PWM Base clock is system clock (16MHz) divided by prescaler
14#[derive(Debug, Eq, PartialEq, Clone, Copy)] 297#[derive(Debug, Eq, PartialEq, Clone, Copy)]
15pub enum Prescaler { 298pub enum Prescaler {
16 Div1, 299 Div1,
@@ -23,20 +306,42 @@ pub enum Prescaler {
23 Div128, 306 Div128,
24} 307}
25 308
26/// Interface to the UARTE peripheral 309/// How the sequence values are distributed across the channels
27pub struct Pwm<'d, T: Instance> { 310#[derive(Debug, Eq, PartialEq, Clone, Copy)]
28 phantom: PhantomData<&'d mut T>, 311pub enum SequenceLoad {
312 /// Provided sequence will be used across all channels
313 Common,
314 /// Provided sequence contains grouped values for each channel ex:
315 /// [ch0_0_and_ch1_0, ch2_0_and_ch3_0, ... ch0_n_and_ch1_n, ch2_n_and_ch3_n]
316 Grouped,
317 /// Provided sequence contains individual values for each channel ex:
318 /// [ch0_0, ch1_0, ch2_0, ch3_0... ch0_n, ch1_n, ch2_n, ch3_n]
319 Individual,
320 /// Similar to Individual mode, but only three channels are used. The fourth
321 /// value is loaded into the pulse generator counter as its top value.
322 Waveform,
29} 323}
30 324
31impl<'d, T: Instance> Pwm<'d, T> { 325/// Selects up mode or up-and-down mode for the counter
32 /// Creates the interface to a UARTE instance. 326#[derive(Debug, Eq, PartialEq, Clone, Copy)]
33 /// Sets the baud rate, parity and assigns the pins to the UARTE peripheral. 327pub enum CounterMode {
328 /// Up counter (edge-aligned PWM duty cycle)
329 Up,
330 /// Up and down counter (center-aligned PWM duty cycle)
331 UpAndDown,
332}
333
334impl<'d, T: Instance> SimplePwm<'d, T> {
335 /// Creates the interface to a `SimplePwm`
336 ///
337 /// Defaults the freq to 1Mhz, max_duty 1000, duty 0, up mode, and pins low.
338 /// Must be started by calling `set_duty`
34 /// 339 ///
35 /// # Safety 340 /// # Safety
36 /// 341 ///
37 /// The returned API is safe unless you use `mem::forget` (or similar safe mechanisms) 342 /// The returned API is safe unless you use `mem::forget` (or similar safe
38 /// on stack allocated buffers which which have been passed to [`send()`](Pwm::send) 343 /// mechanisms) on stack allocated buffers which which have been passed to
39 /// or [`receive`](Pwm::receive). 344 /// [`new()`](SimplePwm::new).
40 #[allow(unused_unsafe)] 345 #[allow(unused_unsafe)]
41 pub fn new( 346 pub fn new(
42 _pwm: impl Unborrow<Target = T> + 'd, 347 _pwm: impl Unborrow<Target = T> + 'd,
@@ -48,7 +353,6 @@ impl<'d, T: Instance> Pwm<'d, T> {
48 unborrow!(ch0, ch1, ch2, ch3); 353 unborrow!(ch0, ch1, ch2, ch3);
49 354
50 let r = T::regs(); 355 let r = T::regs();
51 let s = T::state();
52 356
53 if let Some(pin) = ch0.pin_mut() { 357 if let Some(pin) = ch0.pin_mut() {
54 pin.set_low(); 358 pin.set_low();
@@ -66,22 +370,36 @@ impl<'d, T: Instance> Pwm<'d, T> {
66 pin.set_low(); 370 pin.set_low();
67 pin.conf().write(|w| w.dir().output()); 371 pin.conf().write(|w| w.dir().output());
68 } 372 }
373
374 // if NoPin provided writes disconnected (top bit 1) 0x80000000 else
375 // writes pin number ex 13 (0x0D) which is connected (top bit 0)
69 r.psel.out[0].write(|w| unsafe { w.bits(ch0.psel_bits()) }); 376 r.psel.out[0].write(|w| unsafe { w.bits(ch0.psel_bits()) });
70 r.psel.out[1].write(|w| unsafe { w.bits(ch1.psel_bits()) }); 377 r.psel.out[1].write(|w| unsafe { w.bits(ch1.psel_bits()) });
71 r.psel.out[2].write(|w| unsafe { w.bits(ch2.psel_bits()) }); 378 r.psel.out[2].write(|w| unsafe { w.bits(ch2.psel_bits()) });
72 r.psel.out[3].write(|w| unsafe { w.bits(ch3.psel_bits()) }); 379 r.psel.out[3].write(|w| unsafe { w.bits(ch3.psel_bits()) });
73 380
381 let pwm = Self {
382 phantom: PhantomData,
383 ch0: ch0.degrade_optional(),
384 ch1: ch1.degrade_optional(),
385 ch2: ch2.degrade_optional(),
386 ch3: ch3.degrade_optional(),
387 duty: [0; 4],
388 };
389
74 // Disable all interrupts 390 // Disable all interrupts
75 r.intenclr.write(|w| unsafe { w.bits(0xFFFF_FFFF) }); 391 r.intenclr.write(|w| unsafe { w.bits(0xFFFF_FFFF) });
392 r.shorts.reset();
76 393
77 // Enable 394 // Enable
78 r.enable.write(|w| w.enable().enabled()); 395 r.enable.write(|w| w.enable().enabled());
79 396
80 r.seq0 397 r.seq0
81 .ptr 398 .ptr
82 .write(|w| unsafe { w.bits(&s.duty as *const _ as u32) }); 399 .write(|w| unsafe { w.bits(&pwm.duty as *const _ as u32) });
400
83 r.seq0.cnt.write(|w| unsafe { w.bits(4) }); 401 r.seq0.cnt.write(|w| unsafe { w.bits(4) });
84 r.seq0.refresh.write(|w| unsafe { w.bits(32) }); 402 r.seq0.refresh.write(|w| unsafe { w.bits(0) });
85 r.seq0.enddelay.write(|w| unsafe { w.bits(0) }); 403 r.seq0.enddelay.write(|w| unsafe { w.bits(0) });
86 404
87 r.decoder.write(|w| { 405 r.decoder.write(|w| {
@@ -89,14 +407,24 @@ impl<'d, T: Instance> Pwm<'d, T> {
89 w.mode().refresh_count() 407 w.mode().refresh_count()
90 }); 408 });
91 r.mode.write(|w| w.updown().up()); 409 r.mode.write(|w| w.updown().up());
92 r.prescaler.write(|w| w.prescaler().div_1()); 410 r.prescaler.write(|w| w.prescaler().div_16());
93 r.countertop 411 r.countertop.write(|w| unsafe { w.countertop().bits(1000) });
94 .write(|w| unsafe { w.countertop().bits(32767) });
95 r.loop_.write(|w| w.cnt().disabled()); 412 r.loop_.write(|w| w.cnt().disabled());
96 413
97 Self { 414 pwm
98 phantom: PhantomData, 415 }
99 } 416
417 /// Stop playback
418 #[inline(always)]
419 pub fn stop(&self) {
420 let r = T::regs();
421
422 r.shorts.reset();
423
424 compiler_fence(Ordering::SeqCst);
425
426 // tasks_stop() doesn't exist in all svds so write its bit instead
427 r.tasks_stop.write(|w| unsafe { w.bits(0x01) });
100 } 428 }
101 429
102 /// Enables the PWM generator. 430 /// Enables the PWM generator.
@@ -114,12 +442,24 @@ impl<'d, T: Instance> Pwm<'d, T> {
114 } 442 }
115 443
116 /// Sets duty cycle (15 bit) for a PWM channel. 444 /// Sets duty cycle (15 bit) for a PWM channel.
117 pub fn set_duty(&self, channel: usize, duty: u16) { 445 pub fn set_duty(&mut self, channel: usize, duty: u16) {
118 let s = T::state(); 446 let r = T::regs();
119 unsafe { (*s.duty.get())[channel] = duty & 0x7FFF };
120 447
448 self.duty[channel] = duty & 0x7FFF;
449
450 r.seq0
451 .ptr
452 .write(|w| unsafe { w.bits(&self.duty as *const _ as u32) });
453
454 // defensive before seqstart
121 compiler_fence(Ordering::SeqCst); 455 compiler_fence(Ordering::SeqCst);
122 T::regs().tasks_seqstart[0].write(|w| unsafe { w.bits(1) }); 456
457 // tasks_seqstart() doesn't exist in all svds so write its bit instead
458 r.tasks_seqstart[0].write(|w| unsafe { w.bits(1) });
459
460 // defensive wait until waveform is loaded after seqstart
461 while r.events_seqend[0].read().bits() == 0 {}
462 r.events_seqend[0].write(|w| w);
123 } 463 }
124 464
125 /// Sets the PWM clock prescaler. 465 /// Sets the PWM clock prescaler.
@@ -128,7 +468,7 @@ impl<'d, T: Instance> Pwm<'d, T> {
128 T::regs().prescaler.write(|w| w.prescaler().bits(div as u8)); 468 T::regs().prescaler.write(|w| w.prescaler().bits(div as u8));
129 } 469 }
130 470
131 /// Sets the PWM clock prescaler. 471 /// Gets the PWM clock prescaler.
132 #[inline(always)] 472 #[inline(always)]
133 pub fn prescaler(&self) -> Prescaler { 473 pub fn prescaler(&self) -> Prescaler {
134 match T::regs().prescaler.read().prescaler().bits() { 474 match T::regs().prescaler.read().prescaler().bits() {
@@ -175,36 +515,41 @@ impl<'d, T: Instance> Pwm<'d, T> {
175 } 515 }
176} 516}
177 517
178impl<'a, T: Instance> Drop for Pwm<'a, T> { 518impl<'a, T: Instance> Drop for SimplePwm<'a, T> {
179 fn drop(&mut self) { 519 fn drop(&mut self) {
180 let r = T::regs(); 520 let r = T::regs();
181 r.enable.write(|w| w.enable().disabled());
182 521
183 info!("pwm drop: done"); 522 self.stop();
523 self.disable();
184 524
185 // TODO: disable pins 525 if let Some(pin) = &self.ch0 {
526 pin.set_low();
527 pin.conf().write(|w| w);
528 r.psel.out[0].write(|w| unsafe { w.bits(0x80000000) });
529 }
530 if let Some(pin) = &self.ch1 {
531 pin.set_low();
532 pin.conf().write(|w| w);
533 r.psel.out[1].write(|w| unsafe { w.bits(0x80000000) });
534 }
535 if let Some(pin) = &self.ch2 {
536 pin.set_low();
537 pin.conf().write(|w| w);
538 r.psel.out[2].write(|w| unsafe { w.bits(0x80000000) });
539 }
540 if let Some(pin) = &self.ch3 {
541 pin.set_low();
542 pin.conf().write(|w| w);
543 r.psel.out[3].write(|w| unsafe { w.bits(0x80000000) });
544 }
186 } 545 }
187} 546}
188 547
189pub(crate) mod sealed { 548pub(crate) mod sealed {
190 use super::*; 549 use super::*;
191 550
192 pub struct State {
193 pub duty: UnsafeCell<[u16; 4]>,
194 }
195 unsafe impl Sync for State {}
196
197 impl State {
198 pub const fn new() -> Self {
199 Self {
200 duty: UnsafeCell::new([0; 4]),
201 }
202 }
203 }
204
205 pub trait Instance { 551 pub trait Instance {
206 fn regs() -> &'static pac::pwm0::RegisterBlock; 552 fn regs() -> &'static pac::pwm0::RegisterBlock;
207 fn state() -> &'static State;
208 } 553 }
209} 554}
210 555
@@ -218,10 +563,6 @@ macro_rules! impl_pwm {
218 fn regs() -> &'static pac::pwm0::RegisterBlock { 563 fn regs() -> &'static pac::pwm0::RegisterBlock {
219 unsafe { &*pac::$pac_type::ptr() } 564 unsafe { &*pac::$pac_type::ptr() }
220 } 565 }
221 fn state() -> &'static crate::pwm::sealed::State {
222 static STATE: crate::pwm::sealed::State = crate::pwm::sealed::State::new();
223 &STATE
224 }
225 } 566 }
226 impl crate::pwm::Instance for peripherals::$type { 567 impl crate::pwm::Instance for peripherals::$type {
227 type Interrupt = crate::interrupt::$irq; 568 type Interrupt = crate::interrupt::$irq;
diff --git a/embassy-nrf/src/util.rs b/embassy-nrf/src/util.rs
index 344fb01f9..2fd0bc5a8 100644
--- a/embassy-nrf/src/util.rs
+++ b/embassy-nrf/src/util.rs
@@ -2,15 +2,15 @@ const SRAM_LOWER: usize = 0x2000_0000;
2const SRAM_UPPER: usize = 0x3000_0000; 2const SRAM_UPPER: usize = 0x3000_0000;
3 3
4/// Does this slice reside entirely within RAM? 4/// Does this slice reside entirely within RAM?
5pub(crate) fn slice_in_ram(slice: &[u8]) -> bool { 5pub(crate) fn slice_in_ram<T>(slice: &[T]) -> bool {
6 let ptr = slice.as_ptr() as usize; 6 let ptr = slice.as_ptr() as usize;
7 ptr >= SRAM_LOWER && (ptr + slice.len()) < SRAM_UPPER 7 ptr >= SRAM_LOWER && (ptr + slice.len() * core::mem::size_of::<T>()) < SRAM_UPPER
8} 8}
9 9
10/// Return an error if slice is not in RAM. 10/// Return an error if slice is not in RAM.
11#[cfg(not(feature = "nrf51"))] 11#[cfg(not(feature = "nrf51"))]
12pub(crate) fn slice_in_ram_or<T>(slice: &[u8], err: T) -> Result<(), T> { 12pub(crate) fn slice_in_ram_or<T, E>(slice: &[T], err: E) -> Result<(), E> {
13 if slice.len() == 0 || slice_in_ram(slice) { 13 if slice.is_empty() || slice_in_ram(slice) {
14 Ok(()) 14 Ok(())
15 } else { 15 } else {
16 Err(err) 16 Err(err)
diff --git a/examples/nrf/src/bin/pwm.rs b/examples/nrf/src/bin/pwm.rs
index ab033eb50..8679eddd8 100644
--- a/examples/nrf/src/bin/pwm.rs
+++ b/examples/nrf/src/bin/pwm.rs
@@ -7,7 +7,7 @@ mod example_common;
7use defmt::*; 7use defmt::*;
8use embassy::executor::Spawner; 8use embassy::executor::Spawner;
9use embassy::time::{Duration, Timer}; 9use embassy::time::{Duration, Timer};
10use embassy_nrf::pwm::{Prescaler, Pwm}; 10use embassy_nrf::pwm::{Prescaler, SimplePwm};
11use embassy_nrf::Peripherals; 11use embassy_nrf::Peripherals;
12 12
13// for i in range(1024): print(int((math.sin(i/512*math.pi)*0.4+0.5)**2*32767), ', ', end='') 13// for i in range(1024): print(int((math.sin(i/512*math.pi)*0.4+0.5)**2*32767), ', ', end='')
@@ -85,8 +85,9 @@ static DUTY: [u16; 1024] = [
85 85
86#[embassy::main] 86#[embassy::main]
87async fn main(_spawner: Spawner, p: Peripherals) { 87async fn main(_spawner: Spawner, p: Peripherals) {
88 let pwm = Pwm::new(p.PWM0, p.P0_13, p.P0_14, p.P0_16, p.P0_15); 88 let mut pwm = SimplePwm::new(p.PWM0, p.P0_13, p.P0_14, p.P0_16, p.P0_15);
89 pwm.set_prescaler(Prescaler::Div1); 89 pwm.set_prescaler(Prescaler::Div1);
90 pwm.set_max_duty(32767);
90 info!("pwm initialized!"); 91 info!("pwm initialized!");
91 92
92 let mut i = 0; 93 let mut i = 0;
diff --git a/examples/nrf/src/bin/pwm_led.rs b/examples/nrf/src/bin/pwm_led.rs
new file mode 100644
index 000000000..d0b71a5cd
--- /dev/null
+++ b/examples/nrf/src/bin/pwm_led.rs
@@ -0,0 +1,47 @@
1#![no_std]
2#![no_main]
3#![feature(type_alias_impl_trait)]
4
5#[path = "../example_common.rs"]
6mod example_common;
7use defmt::*;
8use embassy::executor::Spawner;
9use embassy::time::{Duration, Timer};
10use embassy_nrf::gpio::NoPin;
11use embassy_nrf::pwm::{Prescaler, SimplePwm};
12use embassy_nrf::Peripherals;
13
14#[embassy::main]
15async fn main(_spawner: Spawner, p: Peripherals) {
16 let mut pwm = SimplePwm::new(p.PWM0, p.P0_13, NoPin, NoPin, NoPin);
17 // set_period doesnt actually set what you give it, because it only has a
18 // few options from the hardhware so be explicit instead
19 // Div128 is slowest, 125khz still crazy fast for our eyes
20 pwm.set_prescaler(Prescaler::Div128);
21
22 info!("pwm initialized!");
23
24 // default max_duty if not specified is 1000
25 // so 0 would be fully off and 1000 or above would be fully on
26 loop {
27 info!("100%");
28 pwm.set_duty(0, 1000);
29 Timer::after(Duration::from_millis(5000)).await;
30
31 info!("25%");
32 pwm.set_duty(0, 250);
33 Timer::after(Duration::from_millis(5000)).await;
34
35 info!("10%");
36 pwm.set_duty(0, 100);
37 Timer::after(Duration::from_millis(5000)).await;
38
39 info!("5%");
40 pwm.set_duty(0, 50);
41 Timer::after(Duration::from_millis(5000)).await;
42
43 info!("0%");
44 pwm.set_duty(0, 0);
45 Timer::after(Duration::from_millis(5000)).await;
46 }
47}
diff --git a/examples/nrf/src/bin/pwm_sequence.rs b/examples/nrf/src/bin/pwm_sequence.rs
new file mode 100644
index 000000000..d02b0c9c5
--- /dev/null
+++ b/examples/nrf/src/bin/pwm_sequence.rs
@@ -0,0 +1,115 @@
1#![no_std]
2#![no_main]
3#![feature(type_alias_impl_trait)]
4
5#[path = "../example_common.rs"]
6mod example_common;
7use defmt::*;
8use embassy::executor::Spawner;
9use embassy::time::{Duration, Timer};
10use embassy_nrf::gpio::NoPin;
11use embassy_nrf::pwm::{Prescaler, SequenceConfig, SequenceMode, SequencePwm};
12use embassy_nrf::Peripherals;
13
14#[embassy::main]
15async fn main(_spawner: Spawner, p: Peripherals) {
16 // for i in range(1024): print(int((math.sin(i/512*math.pi)*0.4+0.5)**2*32767), ', ', end='')
17 let seq_values: [u16; 1024] = [
18 8191, 8272, 8353, 8434, 8516, 8598, 8681, 8764, 8847, 8931, 9015, 9099, 9184, 9269, 9354,
19 9440, 9526, 9613, 9700, 9787, 9874, 9962, 10050, 10139, 10227, 10316, 10406, 10495, 10585,
20 10675, 10766, 10857, 10948, 11039, 11131, 11223, 11315, 11407, 11500, 11592, 11685, 11779,
21 11872, 11966, 12060, 12154, 12248, 12343, 12438, 12533, 12628, 12723, 12818, 12914, 13010,
22 13106, 13202, 13298, 13394, 13491, 13587, 13684, 13781, 13878, 13975, 14072, 14169, 14266,
23 14364, 14461, 14558, 14656, 14754, 14851, 14949, 15046, 15144, 15242, 15339, 15437, 15535,
24 15632, 15730, 15828, 15925, 16023, 16120, 16218, 16315, 16412, 16510, 16607, 16704, 16801,
25 16898, 16995, 17091, 17188, 17284, 17380, 17477, 17572, 17668, 17764, 17859, 17955, 18050,
26 18145, 18239, 18334, 18428, 18522, 18616, 18710, 18803, 18896, 18989, 19082, 19174, 19266,
27 19358, 19449, 19540, 19631, 19722, 19812, 19902, 19991, 20081, 20169, 20258, 20346, 20434,
28 20521, 20608, 20695, 20781, 20867, 20952, 21037, 21122, 21206, 21290, 21373, 21456, 21538,
29 21620, 21701, 21782, 21863, 21943, 22022, 22101, 22179, 22257, 22335, 22412, 22488, 22564,
30 22639, 22714, 22788, 22861, 22934, 23007, 23079, 23150, 23220, 23290, 23360, 23429, 23497,
31 23564, 23631, 23698, 23763, 23828, 23892, 23956, 24019, 24081, 24143, 24204, 24264, 24324,
32 24383, 24441, 24499, 24555, 24611, 24667, 24721, 24775, 24828, 24881, 24933, 24983, 25034,
33 25083, 25132, 25180, 25227, 25273, 25319, 25363, 25407, 25451, 25493, 25535, 25575, 25615,
34 25655, 25693, 25731, 25767, 25803, 25838, 25873, 25906, 25939, 25971, 26002, 26032, 26061,
35 26089, 26117, 26144, 26170, 26195, 26219, 26242, 26264, 26286, 26307, 26327, 26346, 26364,
36 26381, 26397, 26413, 26427, 26441, 26454, 26466, 26477, 26487, 26496, 26505, 26512, 26519,
37 26525, 26530, 26534, 26537, 26539, 26540, 26541, 26540, 26539, 26537, 26534, 26530, 26525,
38 26519, 26512, 26505, 26496, 26487, 26477, 26466, 26454, 26441, 26427, 26413, 26397, 26381,
39 26364, 26346, 26327, 26307, 26286, 26264, 26242, 26219, 26195, 26170, 26144, 26117, 26089,
40 26061, 26032, 26002, 25971, 25939, 25906, 25873, 25838, 25803, 25767, 25731, 25693, 25655,
41 25615, 25575, 25535, 25493, 25451, 25407, 25363, 25319, 25273, 25227, 25180, 25132, 25083,
42 25034, 24983, 24933, 24881, 24828, 24775, 24721, 24667, 24611, 24555, 24499, 24441, 24383,
43 24324, 24264, 24204, 24143, 24081, 24019, 23956, 23892, 23828, 23763, 23698, 23631, 23564,
44 23497, 23429, 23360, 23290, 23220, 23150, 23079, 23007, 22934, 22861, 22788, 22714, 22639,
45 22564, 22488, 22412, 22335, 22257, 22179, 22101, 22022, 21943, 21863, 21782, 21701, 21620,
46 21538, 21456, 21373, 21290, 21206, 21122, 21037, 20952, 20867, 20781, 20695, 20608, 20521,
47 20434, 20346, 20258, 20169, 20081, 19991, 19902, 19812, 19722, 19631, 19540, 19449, 19358,
48 19266, 19174, 19082, 18989, 18896, 18803, 18710, 18616, 18522, 18428, 18334, 18239, 18145,
49 18050, 17955, 17859, 17764, 17668, 17572, 17477, 17380, 17284, 17188, 17091, 16995, 16898,
50 16801, 16704, 16607, 16510, 16412, 16315, 16218, 16120, 16023, 15925, 15828, 15730, 15632,
51 15535, 15437, 15339, 15242, 15144, 15046, 14949, 14851, 14754, 14656, 14558, 14461, 14364,
52 14266, 14169, 14072, 13975, 13878, 13781, 13684, 13587, 13491, 13394, 13298, 13202, 13106,
53 13010, 12914, 12818, 12723, 12628, 12533, 12438, 12343, 12248, 12154, 12060, 11966, 11872,
54 11779, 11685, 11592, 11500, 11407, 11315, 11223, 11131, 11039, 10948, 10857, 10766, 10675,
55 10585, 10495, 10406, 10316, 10227, 10139, 10050, 9962, 9874, 9787, 9700, 9613, 9526, 9440,
56 9354, 9269, 9184, 9099, 9015, 8931, 8847, 8764, 8681, 8598, 8516, 8434, 8353, 8272, 8191,
57 8111, 8031, 7952, 7873, 7794, 7716, 7638, 7561, 7484, 7407, 7331, 7255, 7180, 7105, 7031,
58 6957, 6883, 6810, 6738, 6665, 6594, 6522, 6451, 6381, 6311, 6241, 6172, 6104, 6036, 5968,
59 5901, 5834, 5767, 5702, 5636, 5571, 5507, 5443, 5379, 5316, 5253, 5191, 5130, 5068, 5008,
60 4947, 4888, 4828, 4769, 4711, 4653, 4596, 4539, 4482, 4426, 4371, 4316, 4261, 4207, 4153,
61 4100, 4047, 3995, 3943, 3892, 3841, 3791, 3741, 3691, 3642, 3594, 3546, 3498, 3451, 3404,
62 3358, 3312, 3267, 3222, 3178, 3134, 3090, 3047, 3005, 2962, 2921, 2879, 2839, 2798, 2758,
63 2719, 2680, 2641, 2603, 2565, 2528, 2491, 2454, 2418, 2382, 2347, 2312, 2278, 2244, 2210,
64 2177, 2144, 2112, 2080, 2048, 2017, 1986, 1956, 1926, 1896, 1867, 1838, 1810, 1781, 1754,
65 1726, 1699, 1673, 1646, 1620, 1595, 1570, 1545, 1520, 1496, 1472, 1449, 1426, 1403, 1380,
66 1358, 1336, 1315, 1294, 1273, 1252, 1232, 1212, 1192, 1173, 1154, 1135, 1117, 1099, 1081,
67 1063, 1046, 1029, 1012, 996, 980, 964, 948, 933, 918, 903, 888, 874, 860, 846, 833, 819,
68 806, 793, 781, 768, 756, 744, 733, 721, 710, 699, 688, 677, 667, 657, 647, 637, 627, 618,
69 609, 599, 591, 582, 574, 565, 557, 549, 541, 534, 526, 519, 512, 505, 498, 492, 485, 479,
70 473, 467, 461, 455, 450, 444, 439, 434, 429, 424, 419, 415, 410, 406, 402, 398, 394, 390,
71 386, 383, 379, 376, 373, 370, 367, 364, 361, 359, 356, 354, 351, 349, 347, 345, 343, 342,
72 340, 338, 337, 336, 334, 333, 332, 331, 330, 330, 329, 328, 328, 328, 327, 327, 327, 327,
73 327, 328, 328, 328, 329, 330, 330, 331, 332, 333, 334, 336, 337, 338, 340, 342, 343, 345,
74 347, 349, 351, 354, 356, 359, 361, 364, 367, 370, 373, 376, 379, 383, 386, 390, 394, 398,
75 402, 406, 410, 415, 419, 424, 429, 434, 439, 444, 450, 455, 461, 467, 473, 479, 485, 492,
76 498, 505, 512, 519, 526, 534, 541, 549, 557, 565, 574, 582, 591, 599, 609, 618, 627, 637,
77 647, 657, 667, 677, 688, 699, 710, 721, 733, 744, 756, 768, 781, 793, 806, 819, 833, 846,
78 860, 874, 888, 903, 918, 933, 948, 964, 980, 996, 1012, 1029, 1046, 1063, 1081, 1099, 1117,
79 1135, 1154, 1173, 1192, 1212, 1232, 1252, 1273, 1294, 1315, 1336, 1358, 1380, 1403, 1426,
80 1449, 1472, 1496, 1520, 1545, 1570, 1595, 1620, 1646, 1673, 1699, 1726, 1754, 1781, 1810,
81 1838, 1867, 1896, 1926, 1956, 1986, 2017, 2048, 2080, 2112, 2144, 2177, 2210, 2244, 2278,
82 2312, 2347, 2382, 2418, 2454, 2491, 2528, 2565, 2603, 2641, 2680, 2719, 2758, 2798, 2839,
83 2879, 2921, 2962, 3005, 3047, 3090, 3134, 3178, 3222, 3267, 3312, 3358, 3404, 3451, 3498,
84 3546, 3594, 3642, 3691, 3741, 3791, 3841, 3892, 3943, 3995, 4047, 4100, 4153, 4207, 4261,
85 4316, 4371, 4426, 4482, 4539, 4596, 4653, 4711, 4769, 4828, 4888, 4947, 5008, 5068, 5130,
86 5191, 5253, 5316, 5379, 5443, 5507, 5571, 5636, 5702, 5767, 5834, 5901, 5968, 6036, 6104,
87 6172, 6241, 6311, 6381, 6451, 6522, 6594, 6665, 6738, 6810, 6883, 6957, 7031, 7105, 7180,
88 7255, 7331, 7407, 7484, 7561, 7638, 7716, 7794, 7873, 7952, 8031, 8111,
89 ];
90
91 let mut config = SequenceConfig::default();
92 config.prescaler = Prescaler::Div1;
93 // 1 period is 32767 * 1/16mhz = 0.002047938 = 2.047938ms
94 config.top = 32767;
95 // pwm example is delaying >~3ms before updating duty cycle, our refreshes
96 // happen exactly at 2.047938ms so we need a delay after each value of >~1ms
97 // which for us is ~1-2 periods
98 config.refresh = 3;
99
100 let pwm = unwrap!(SequencePwm::new(
101 p.PWM0,
102 p.P0_13,
103 NoPin,
104 NoPin,
105 NoPin,
106 config,
107 &seq_values
108 ));
109 let _ = pwm.start(SequenceMode::Infinite);
110 info!("pwm started!");
111
112 loop {
113 Timer::after(Duration::from_millis(1000)).await;
114 }
115}
diff --git a/examples/nrf/src/bin/pwm_servo.rs b/examples/nrf/src/bin/pwm_servo.rs
new file mode 100644
index 000000000..700b88574
--- /dev/null
+++ b/examples/nrf/src/bin/pwm_servo.rs
@@ -0,0 +1,48 @@
1#![no_std]
2#![no_main]
3#![feature(type_alias_impl_trait)]
4
5#[path = "../example_common.rs"]
6mod example_common;
7use defmt::*;
8use embassy::executor::Spawner;
9use embassy::time::{Duration, Timer};
10use embassy_nrf::gpio::NoPin;
11use embassy_nrf::pwm::{Prescaler, SimplePwm};
12use embassy_nrf::Peripherals;
13
14#[embassy::main]
15async fn main(_spawner: Spawner, p: Peripherals) {
16 let mut pwm = SimplePwm::new(p.PWM0, p.P0_05, NoPin, NoPin, NoPin);
17 // sg90 microervo requires 50hz or 20ms period
18 // set_period can only set down to 125khz so we cant use it directly
19 // Div128 is 125khz or 0.000008s or 0.008ms, 20/0.008 is 2500 is top
20 pwm.set_prescaler(Prescaler::Div128);
21 pwm.set_max_duty(2500);
22 info!("pwm initialized!");
23
24 Timer::after(Duration::from_millis(5000)).await;
25
26 // 1ms 0deg (1/.008=125), 1.5ms 90deg (1.5/.008=187.5), 2ms 180deg (2/.008=250),
27 loop {
28 info!("45 deg");
29 pwm.set_duty(0, 2500 - 156);
30 Timer::after(Duration::from_millis(5000)).await;
31
32 info!("90 deg");
33 pwm.set_duty(0, 2500 - 187);
34 Timer::after(Duration::from_millis(5000)).await;
35
36 info!("135 deg");
37 pwm.set_duty(0, 2500 - 218);
38 Timer::after(Duration::from_millis(5000)).await;
39
40 info!("180 deg");
41 pwm.set_duty(0, 2500 - 250);
42 Timer::after(Duration::from_millis(5000)).await;
43
44 info!("0 deg");
45 pwm.set_duty(0, 2500 - 125);
46 Timer::after(Duration::from_millis(5000)).await;
47 }
48}