alex/rp-hal-boards
1
0
Fork 0
mirror of https://github.com/italicsjenga/rp-hal-boards.git synced 2025-01-11 13:01:30 +11:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation to public functions and struct, fix logic issue with max period

Browse source
This commit is contained in:
jspaulsen 2021-05-17 16:58:12 -07:00 committed by 9names
parent c568f0d3df
commit c4cd2ffe52
1 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
rp2040-hal/src/watchdog.rs
View file

@ -4,14 +4,14 @@ use crate::pac::WATCHDOG;
use embedded_hal::watchdog; use embedded_hal::watchdog;
use embedded_time::{duration, fixed_point::FixedPoint}; use embedded_time::{duration, fixed_point::FixedPoint};
/// /// Watchdog peripheral
pub struct Watchdog { pub struct Watchdog {
watchdog: WATCHDOG, watchdog: WATCHDOG,
delay_ms: u32, delay_ms: u32,
} }
impl Watchdog { impl Watchdog {
/// /// Create a new [`Watchdog`]
pub fn new(watchdog: WATCHDOG) -> Self { pub fn new(watchdog: WATCHDOG) -> Self {
Self { Self {
watchdog, watchdog,
@ -19,7 +19,11 @@ impl Watchdog {
} }
} }
/// Starts tick generation on clk_tick which is driven from clk_ref.
/// ///
/// # Arguments
///
/// * `cycles` - Total number of tick cycles before the next tick is generated.
pub fn enable_tick_generation(&mut self, cycles: u8) { pub fn enable_tick_generation(&mut self, cycles: u8) {
const WATCHDOG_TICK_ENABLE_BITS: u32 = 0x200; const WATCHDOG_TICK_ENABLE_BITS: u32 = 0x200;
@ -28,7 +32,12 @@ impl Watchdog {
.write(|w| unsafe { w.bits(WATCHDOG_TICK_ENABLE_BITS | cycles as u32) }) .write(|w| unsafe { w.bits(WATCHDOG_TICK_ENABLE_BITS | cycles as u32) })
} }
/// Defines whether or not the watchdog timer should be paused when processor(s) are in debug mode
/// or when JTAG is accessing bus fabric
/// ///
/// # Arguments
///
/// * `pause` - If true, watchdog timer will be paused
pub fn pause_on_debug(&mut self, pause: bool) { pub fn pause_on_debug(&mut self, pause: bool) {
self.watchdog.ctrl.write(|w| { self.watchdog.ctrl.write(|w| {
w.pause_dbg0() w.pause_dbg0()
@ -59,7 +68,7 @@ impl watchdog::WatchdogEnable for Watchdog {
type Time = duration::Microseconds; type Time = duration::Microseconds;
fn start<T: Into<Self::Time>>(&mut self, period: T) { fn start<T: Into<Self::Time>>(&mut self, period: T) {
const MAX_PERIOD: u32 = 0x7FFFFF; const MAX_PERIOD: u32 = 0xFFFFFF;
// Due to a logic error, the watchdog decrements by 2 and // Due to a logic error, the watchdog decrements by 2 and
// the load value must be compensated; see RP2040-E1 // the load value must be compensated; see RP2040-E1