veecle-freertos-integration 0.1.2

Rust wrapper for FreeRTOS
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

use veecle_freertos_sys::bindings::{TickType_t, vTaskStartScheduler, xTaskGetTickCount};

use crate::Duration;

/// Starts the FreeRTOS scheduler.
///
/// This function isn't expected to return unless `vTaskEndScheduler` is called.
pub fn start_scheduler() {
    // SAFETY:
    // TODO(unsound): The caller must ensure this function is called once, or after `vTaskEndScheduler` has been called.
    unsafe {
        vTaskStartScheduler();
    }
}

/// Returns the count of ticks since [start_scheduler] was called.
pub fn get_tick_count() -> TickType_t {
    // SAFETY:
    // No requirements on the caller in non-ISR contexts. The README stipulates non-ISR-safe methods to not be used in
    // ISR contexts.
    unsafe { xTaskGetTickCount() }
}

/// Like [get_tick_count], but returns the time since [start_scheduler] was called as a [Duration].
pub fn get_tick_count_duration() -> Duration {
    Duration::from_ticks(get_tick_count())
}