axcpu 0.3.1

Privileged instruction and structure abstractions for various CPU architectures
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! ARM Generic Timer.
//!
//! There are 4 most commonly used timers:
//!
//! - [EL1 Physical Timer][1] (for kernel space use)
//! - [EL1 Virtual Timer][2] (for user space or guest kernel use)
//! - EL2 Physical Timer (for hypervisor use)[^note]
//! - EL3 Physical Timer (for secure monitor use)[^note]
//!
//! [1]: PhysicalTimer
//! [2]: VirtualTimer
//! [^note]: EL2 and EL3 timers are not implemented yet.

/// Common interface for ARM Generic Timer.
pub trait GenericTimer {
    /// Returns the frequency of the timer in Hz.
    fn frequency() -> u32 {
        crate::asm::timer_frequency()
    }

    /// Returns the current value of the timer counter.
    fn counter() -> u64;

    /// Enables or disables the timer.
    fn set_enable(enabled: bool);

    /// Sets the timer to fire an interrupt after the given number of ticks.
    fn set_countdown(ticks: u32);
}

/// The EL1 physical timer.
pub struct PhysicalTimer;

/// The EL1 virtual timer.
pub struct VirtualTimer;

impl GenericTimer for PhysicalTimer {
    fn counter() -> u64 {
        crate::asm::phys_timer_counter()
    }

    fn set_enable(enabled: bool) {
        crate::asm::phys_timer_enable(enabled);
    }

    fn set_countdown(ticks: u32) {
        crate::asm::phys_timer_set_countdown(ticks);
    }
}

impl GenericTimer for VirtualTimer {
    fn counter() -> u64 {
        crate::asm::virt_timer_counter()
    }

    fn set_enable(enabled: bool) {
        crate::asm::virt_timer_enable(enabled);
    }

    fn set_countdown(ticks: u32) {
        crate::asm::virt_timer_set_countdown(ticks);
    }
}