nordic-dev.net/embassy
2
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2024-11-22 06:42:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3495 from carloskiki/patch-1

Browse Source 
Enhanced docs for time driver
This commit is contained in:
Dario Nieuwenhuis 2024-11-03 12:44:49 +00:00 committed by GitHub
commit c75e1e2a9e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
embassy-time-driver/src/lib.rs
View File

@ -109,12 +109,20 @@ pub trait Driver: Send + Sync + 'static {
/// Try allocating an alarm handle. Returns None if no alarms left. /// Try allocating an alarm handle. Returns None if no alarms left.
/// Initially the alarm has no callback set, and a null `ctx` pointer. /// Initially the alarm has no callback set, and a null `ctx` pointer.
/// ///
/// The allocated alarm is a reusable resource and can be used multiple times.
/// Once the alarm has fired, it remains allocated and can be set again without needing
/// to be reallocated.
///
/// # Safety /// # Safety
/// It is UB to make the alarm fire before setting a callback. /// It is UB to make the alarm fire before setting a callback.
unsafe fn allocate_alarm(&self) -> Option<AlarmHandle>; unsafe fn allocate_alarm(&self) -> Option<AlarmHandle>;
/// Set the callback function to be called when the alarm triggers. /// Set the callback function to be called when the alarm triggers.
/// The callback may be called from any context (interrupt or thread mode). /// The callback may be called from any context (interrupt or thread mode).
///
/// The callback is maintained after the alarm has fired. Callers do not need
/// to set a callback again before setting another alarm, unless they want to
/// change the callback function or context.
fn set_alarm_callback(&self, alarm: AlarmHandle, callback: fn(*mut ()), ctx: *mut ()); fn set_alarm_callback(&self, alarm: AlarmHandle, callback: fn(*mut ()), ctx: *mut ());
/// Set an alarm at the given timestamp. /// Set an alarm at the given timestamp.