sbi-rt 0.0.4

Runtime library for supervisors to call RISC-V Supervisor Binary Interface (RISC-V SBI)
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

//! RISC-V SBI runtime primitives library.
//!
//! `sbi-rt` provides fundamental runtime primitives for the RISC-V Supervisor Binary
//! Interface (SBI), wrapping low-level SBI calls in safe Rust interfaces that return
//! `SbiRet` results.
//!
//! All the `SbiRet` types returned by SBI call functions of this crate are `SbiRet<usize>`,
//! representing the pointer width of the current RISC-V SBI platform.
//! Those calls only works at RISC-V targets when building supervisor software
//! (e.g. kernels or hypervisors); it builds under non-RISC-V targets but for tests
//! or `cargo fix` purposes only.
#![no_std]
#[cfg_attr(not(feature = "legacy"), deny(missing_docs))]
// §3
mod binary;
// §4
mod base;
// §5
#[cfg(feature = "legacy")]
pub mod legacy;
// §6
mod time;
// §7
mod spi;
// §8
mod rfnc;
// §9
mod hsm;
// §10
mod srst;
// §11
mod pmu;
// §12
mod dbcn;
// §13
mod susp;
// §14
mod cppc;
// §15
mod nacl;
// §16
mod sta;
// §17
mod sse;
// §18
mod fwft;
// §19
mod dbtr;
// §20
mod mpxy;

pub use sbi_spec::{
    base::Version,
    binary::{CounterMask, HartMask, Physical, SbiRet, SharedPtr},
};

// module `binary` includes crate-local `sbi_call_*` functions and is thus not re-exported
// into the library root.

pub use base::*;
pub use cppc::*;
pub use dbcn::*;
pub use dbtr::*;
pub use fwft::*;
pub use hsm::*;
pub use mpxy::*;
pub use nacl::*;
pub use pmu::*;
pub use rfnc::*;
pub use spi::*;
pub use srst::*;
pub use sse::*;
pub use sta::*;
pub use susp::*;
pub use time::*;

/// Raw RISC-V SBI calls.
///
/// This module is not intended for direct use; it should be used by runtime libraries for custom
/// SBI extensions, to wrap SBI `ecall` instruction into Rust friendly functions.
///
/// SBI runtime users should use functions from root of this library, or functions from other SBI
/// runtime libraries.
pub mod raw {
    use sbi_spec::binary::SbiRet;

    /// Raw SBI call with 0 parameters.
    #[inline(always)]
    pub unsafe fn sbi_call_0(eid: usize, fid: usize) -> SbiRet {
        super::binary::sbi_call_0(eid, fid)
    }

    /// Raw SBI call with 1 parameter.
    #[inline(always)]
    pub unsafe fn sbi_call_1(eid: usize, fid: usize, arg0: usize) -> SbiRet {
        super::binary::sbi_call_1(eid, fid, arg0)
    }

    /// Raw SBI call with 2 parameters.
    #[inline(always)]
    pub unsafe fn sbi_call_2(eid: usize, fid: usize, arg0: usize, arg1: usize) -> SbiRet {
        super::binary::sbi_call_2(eid, fid, arg0, arg1)
    }

    /// Raw SBI call with 3 parameters.
    #[inline(always)]
    pub unsafe fn sbi_call_3(
        eid: usize,
        fid: usize,
        arg0: usize,
        arg1: usize,
        arg2: usize,
    ) -> SbiRet {
        super::binary::sbi_call_3(eid, fid, arg0, arg1, arg2)
    }

    /// Raw SBI call with 4 parameters.
    #[inline(always)]
    pub unsafe fn sbi_call_4(
        eid: usize,
        fid: usize,
        arg0: usize,
        arg1: usize,
        arg2: usize,
        arg3: usize,
    ) -> SbiRet {
        super::binary::sbi_call_4(eid, fid, arg0, arg1, arg2, arg3)
    }

    /// Raw SBI call with 5 parameters.
    #[inline(always)]
    pub unsafe fn sbi_call_5(
        eid: usize,
        fid: usize,
        arg0: usize,
        arg1: usize,
        arg2: usize,
        arg3: usize,
        arg4: usize,
    ) -> SbiRet {
        super::binary::sbi_call_5(eid, fid, arg0, arg1, arg2, arg3, arg4)
    }

    /// Raw SBI call with 6 parameters.
    #[inline(always)]
    pub unsafe fn sbi_call_6(
        eid: usize,
        fid: usize,
        arg0: usize,
        arg1: usize,
        arg2: usize,
        arg3: usize,
        arg4: usize,
        arg5: usize,
    ) -> SbiRet {
        super::binary::sbi_call_6(eid, fid, arg0, arg1, arg2, arg3, arg4, arg5)
    }
}