sifli-hal 0.1.1

Hardware Abstraction Layer (HAL) for SiFli MCUs
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

use critical_section::CriticalSection;

mod clock;
pub use clock::*;

mod clock_configure;
pub use clock_configure::*;

use crate::time::Hertz;

// TODO: should we split this into `RccEnable` and `RccReset` ?
pub(crate) trait SealedRccEnableReset {
    fn rcc_enable() {}

    fn rcc_disable() {}

    fn rcc_reset() {}
}
#[allow(private_bounds)]
pub trait RccEnableReset: SealedRccEnableReset + 'static {}

pub(crate) trait SealedRccGetFreq {
    /// Get peripheral frequency
    /// Returns `None` if clock is disabled
    fn get_freq() -> Option<Hertz>;
}

#[allow(private_bounds)]
pub trait RccGetFreq: SealedRccGetFreq + 'static {
    /// Get peripheral frequency
    /// Returns `None` if clock is disabled
    fn frequency() -> Option<Hertz> {
        Self::get_freq()
    }
}

/// Enables peripheral `T`.
///
/// # Safety
///
/// Peripheral must not be in use.
// TODO: should this be `unsafe`?
pub fn enable_with_cs<T: RccEnableReset>(_cs: CriticalSection) {
    T::rcc_enable();
}

/// Enables peripheral `T`.
///
/// # Safety
///
/// Peripheral must not be in use.
// TODO: should this be `unsafe`?
pub fn enable<T: RccEnableReset>() {
    critical_section::with(|cs| enable_with_cs::<T>(cs));
}

/// Enables and resets peripheral `T`.
///
/// # Safety
///
/// Peripheral must not be in use.
// TODO: should this be `unsafe`?
pub fn enable_and_reset_with_cs<T: RccEnableReset>(_cs: CriticalSection) {
    T::rcc_enable();
    T::rcc_reset();
}


/// Enables and resets peripheral `T`.
///
/// # Safety
///
/// Peripheral must not be in use.
// TODO: should this be `unsafe`?
pub fn enable_and_reset<T: RccEnableReset>() {
    critical_section::with(|cs| enable_and_reset_with_cs::<T>(cs));
}

/// Disables peripheral `T`.
///
/// # Safety
///
/// Peripheral must not be in use.
// TODO: should this be `unsafe`?
pub fn disable_with_cs<T: RccEnableReset>(_cs: CriticalSection) {
    T::rcc_disable();
}

/// Disables peripheral `T`.
///
/// # Safety
///
/// Peripheral must not be in use.
// TODO: should this be `unsafe`?
pub fn disable<T: RccEnableReset>() {
    critical_section::with(|cs| disable_with_cs::<T>(cs));
}