port changes to cramium platform

This commit is contained in:
bunnie 2023-10-10 17:21:34 +08:00
parent 67c2f36789
commit bc18c7e629

View file

@ -1,19 +1,30 @@
const TICKS_PER_MS: u64 = 1;
use core::sync::atomic::{AtomicU32, AtomicUsize, Ordering};
use std::collections::BTreeMap;
use crate::TimerRequest;
use crate::TimeoutExpiry;
#[cfg(features="susres")]
use crate::TimerRequest;
#[cfg(feature="susres")]
use susres::{RegManager, RegOrField, SuspendResume};
use utralib::generated::*;
use xous::definitions::MessageSender;
/// Latency slack may be necessary for hardware implementations that can't handle
/// events that happened in the past. However, for Precursor hardware, alarms will
/// trigger based on a "less than or equal to current time" basis, so even if an
/// alarm happens in the "past" due to slippage between the current time reading
/// and the alarm setting, the alarm should still trigger.
///
/// Note that setting this number larger than 0 will degrade scheduler performance.
const LATENCY_SLACK_MS: i64 = 0;
pub struct XousTickTimer {
csr: utralib::CSR<u32>,
current_response: Option<TimerRequest>,
last_response: Option<TimerRequest>,
connection: xous::CID,
#[cfg(features="susres")]
#[cfg(feature="susres")]
ticktimer_sr_manager: RegManager<{ utra::ticktimer::TICKTIMER_NUMREGS }>,
#[cfg(feature="watchdog")]
wdt_sr_manager: RegManager<{ utra::wdt::WDT_NUMREGS }>,
@ -21,12 +32,25 @@ pub struct XousTickTimer {
wdt: utralib::CSR<u32>,
}
/// Connection ID to the ticktimer server, for use in interrupt contexts.
static TICKTIMER_CONNECTION: AtomicU32 = AtomicU32::new(0);
/// The Message ID of the last message we responded to
static LAST_RESPONDER: AtomicUsize = AtomicUsize::new(0);
/// This is incremented every time the ticktimer IRQ fires. It's used to
/// determine how many events were missed during processing of new
/// ticktimer events.
static TICKTIMER_SEQUENCE_NUMBER: AtomicUsize = AtomicUsize::new(0);
fn handle_irq(_irq_no: usize, arg: *mut usize) {
let xtt = unsafe { &mut *(arg as *mut XousTickTimer) };
let xtt: &mut XousTickTimer = unsafe { &mut *(arg as *mut XousTickTimer) };
let connection = TICKTIMER_CONNECTION.load(Ordering::Relaxed);
// println!("In IRQ, connection: {}", xtt.connection);
// Safe because we're in an interrupt, and this interrupt is only
// enabled when this value is not None.
// enabled when this value is not None. Furthermore, the value is
// only ever updated when interrupts are disabled.
let response = xtt.current_response.take().unwrap();
xous::return_scalar(response.sender, response.kind as usize).ok();
@ -38,7 +62,7 @@ fn handle_irq(_irq_no: usize, arg: *mut usize) {
// Which is fine, because the queue is always recalculated any time a message arrives.
use num_traits::ToPrimitive;
xous::try_send_message(
xtt.connection,
connection,
xous::Message::Scalar(xous::ScalarMessage {
id: crate::api::Opcode::RecalculateSleep.to_usize().unwrap(),
arg1: response.sender.to_usize(),
@ -49,8 +73,12 @@ fn handle_irq(_irq_no: usize, arg: *mut usize) {
)
.ok();
// Save the response so we can be sure we don't double-return messages.
xtt.last_response = Some(response);
// Remember what the last message was that we responded to. This will prevent
// double-responding to messages.
LAST_RESPONDER.store(response.sender.to_usize(), Ordering::Relaxed);
// Note that we've handled another IRQ event.
TICKTIMER_SEQUENCE_NUMBER.fetch_add(1, Ordering::Relaxed);
}
impl XousTickTimer {
@ -71,17 +99,16 @@ impl XousTickTimer {
xous::MemoryFlags::R | xous::MemoryFlags::W,
)
.expect("couldn't map Watchdog timer CSR range");
#[cfg(features="susres")]
#[cfg(feature="susres")]
let ticktimer_sr_manager = RegManager::new(csr.as_mut_ptr() as *mut u32);
#[cfg(feature="watchdog")]
let wdt_sr_manager = RegManager::new(wdt.as_mut_ptr() as *mut u32);
let xtt = XousTickTimer {
#[allow(unused_mut)] // sometimes mut, sometimes not based on feature flags.
let mut xtt = XousTickTimer {
csr: CSR::new(csr.as_mut_ptr() as *mut u32),
current_response: None,
last_response: None,
connection,
#[cfg(features="susres")]
#[cfg(feature="susres")]
ticktimer_sr_manager,
#[cfg(feature="watchdog")]
wdt_sr_manager,
@ -97,25 +124,35 @@ impl XousTickTimer {
// xtt.wdt_sr_manager.push(RegOrField::Field(utra::wdt::WATCHDOG_ENABLE), None);
}
// Keep a copy of the connection around so we can use it in the interrupt.
TICKTIMER_CONNECTION.store(connection.into(), Ordering::Relaxed);
xtt
}
pub fn last_response(&self) -> &Option<TimerRequest> {
&self.last_response
pub fn last_response(&self) -> MessageSender {
MessageSender::from_usize(LAST_RESPONDER.load(Ordering::Relaxed))
}
pub fn clear_last_response(&mut self) {
self.last_response = None;
/// Return the number of times the ticktimer IRQ has fired.
///
/// # Safety
///
/// This function is safe to call only if interrupts are disabled. Otherwise,
/// the value may change during processing.
pub unsafe fn sequence_number() -> usize {
TICKTIMER_SEQUENCE_NUMBER.load(Ordering::Relaxed)
}
pub fn init(&mut self) {
xous::claim_interrupt(
utra::ticktimer::TICKTIMER_IRQ,
handle_irq,
self as *mut XousTickTimer as *mut usize,
)
.expect("couldn't claim irq");
.expect("couldn't claim irq");
#[cfg(features="susres")]
#[cfg(feature="susres")]
{
self.ticktimer_sr_manager
.push(RegOrField::Reg(utra::ticktimer::MSLEEP_TARGET0), None);
@ -167,7 +204,7 @@ impl XousTickTimer {
}
pub fn schedule_response(&mut self, request: TimerRequest) {
let irq_target = request.msec;
let irq_target = request.msec.to_i64().wrapping_add(LATENCY_SLACK_MS);
log::trace!(
"setting a response at {} ms (current time: {} ms)",
irq_target,
@ -217,7 +254,7 @@ impl XousTickTimer {
// example of a generic suspend/resume template
pub fn suspend(&mut self) {
log::trace!("suspending");
#[cfg(features="susres")]
#[cfg(feature="susres")]
self.ticktimer_sr_manager.suspend();
#[cfg(feature="watchdog")]
self.wdt_sr_manager.suspend();
@ -225,6 +262,7 @@ impl XousTickTimer {
// by writing this after suspend(), resume will get the prior value
self.csr.wfo(utra::ticktimer::EV_ENABLE_ALARM, 0);
}
pub fn resume(&mut self) {
// this is a write-once bit that's later erased, so it can't be managed automatically
// thus we have to restore in manually on a resume
@ -236,9 +274,9 @@ impl XousTickTimer {
// manually clear any pending ticktimer events. This is mainly releveant for a "touch-and-go" simulated suspend.
self.csr.wfo(utra::ticktimer::EV_PENDING_ALARM, 1);
#[cfg(feature="watchdog")]
#[cfg(feature="watchdog")]
self.wdt_sr_manager.resume();
#[cfg(features="susres")]
#[cfg(feature="susres")]
self.ticktimer_sr_manager.resume();
log::trace!(
@ -252,14 +290,18 @@ impl XousTickTimer {
);
}
/// Disable the sleep interrupt and remove the currently-pending sleep item.
/// If the sleep item has fired, then there will be no existing sleep item
/// remaining.
pub fn stop_sleep(
///
/// # Returns
///
/// The serial number of the ticktimer handler at the point where
/// interrupts were disabled.
pub(crate) fn stop_sleep(
&mut self,
sleep_heap: &mut BTreeMap<TimeoutExpiry, TimerRequest>, // min-heap with Reverse
) {
) -> usize {
// If there's a sleep request ongoing now, grab it.
if let Some(current) = self.stop_interrupt() {
#[cfg(feature = "debug-print")]
@ -269,9 +311,10 @@ impl XousTickTimer {
#[cfg(feature = "debug-print")]
log::info!("There was no existing sleep() request");
}
TICKTIMER_SEQUENCE_NUMBER.load(Ordering::Relaxed)
}
pub fn start_sleep(
pub(crate) fn start_sleep(
&mut self,
sleep_heap: &mut BTreeMap<TimeoutExpiry, TimerRequest>, // min-heap with Reverse
) {
@ -280,7 +323,9 @@ impl XousTickTimer {
#[cfg(feature = "debug-print")]
log::info!(
"scheduling a response at {} to {} (heap: {:?})",
next_response.msec, next_response.sender, sleep_heap
next_response.msec,
next_response.sender,
sleep_heap
);
self.schedule_response(next_response);
@ -293,20 +338,17 @@ impl XousTickTimer {
}
}
/// Recalculate the sleep timer, optionally adding a new Request to the list of available
/// sleep events. This involves stopping the timer, recalculating the newest item, then
/// restarting the timer.
/// Recalculate sleep without starting and stopping the sleep timer.
///
/// Note that interrupts are always enabled, which is why we must stop the timer prior to
/// reordering the list.
pub fn recalculate_sleep(
/// # Safety
///
/// This must be called with the sleep timer already stopped
pub(crate) unsafe fn recalculate_sleep_offline(
&mut self,
sleep_heap: &mut BTreeMap<TimeoutExpiry, TimerRequest>, // min-heap with Reverse
sleep_heap: &mut BTreeMap<TimeoutExpiry, TimerRequest>,
new: Option<TimerRequest>,
) {
self.stop_sleep(sleep_heap);
log::trace!("Elapsed: {}", self.elapsed_ms());
self.clear_last_response();
// If we have a new sleep request, add it to the heap.
if let Some(mut request) = new {
@ -326,7 +368,21 @@ impl XousTickTimer {
#[cfg(feature = "debug-print")]
log::info!("No new sleep request");
}
}
/// Recalculate the sleep timer, optionally adding a new Request to the list of available
/// sleep events. This involves stopping the timer, recalculating the newest item, then
/// restarting the timer.
///
/// Note that interrupts are always enabled, which is why we must stop the timer prior to
/// reordering the list.
pub(crate) fn recalculate_sleep(
&mut self,
sleep_heap: &mut BTreeMap<TimeoutExpiry, TimerRequest>,
new: Option<TimerRequest>,
) {
self.stop_sleep(sleep_heap);
unsafe { self.recalculate_sleep_offline(sleep_heap, new) }
self.start_sleep(sleep_heap);
}
}