meta/
lib.rs

Help
1//
2// Copyright 2023, Colias Group, LLC
3//
4// SPDX-License-Identifier: BSD-2-Clause
5//
6
7#![no_std]
8#![allow(dead_code)]
9#![allow(non_upper_case_globals)]
10#![allow(unused_imports)]
11
12//! ### General crates
13//!
14//! - [`sel4`]: Straightforward, pure-Rust bindings to the seL4 API.
15//! - [`sel4_sys`]: Raw bindings to the seL4 API, generated from the libsel4 headers and interface
16//!   definition files. This crate is not intended to be used directly by application code, but
17//!   rather serves as a basis for the `sel4` crate's implementation.
18//! - [`sel4_config`]: Macros and constants corresponding to the seL4 kernel configuration. Can be
19//!   used by all targets (i.e. in all of: application code, build scripts, and build-time tools).
20//! - [`sel4_platform_info`]: Constants corresponding to the contents of `platform_info.h`. Can be
21//!   used by all targets, on configurations where this file exists.
22//! - [`sel4_sync`]: Synchronization constructs using seL4 IPC. Currently only supports
23//!   notification-based mutexes.
24//! - [`sel4_logging`]: [`Log`](log::Log) implementation for the [`log`] crate.
25//! - [`sel4_shared_memory`]: Abstractions for interacting with data in shared memory.
26//! - [`sel4_shared_ring_buffer`] and `sel4_shared_ring_buffer_*`: Implementation of shared data structures used in the [seL4 Device
27//!   Driver Framework](https://github.com/au-ts/sddf).
28//! - `sel4_async_*`: Crates for leveraging async Rust in seL4 userspace.
29//! - `sel4_*_driver`: Crates implementing drivers for use with `sel4_shared_ring_buffer_*` and the orthogonal [`sel4_driver_interfaces`].
30//! - ...and many more, including lower-level crates for implementing additional runtimes.
31//!
32//! ### Runtime crates
33//!
34//! - **Root task**:
35//!   - [`sel4_root_task`]: A runtime for root tasks that supports thread-local storage and
36//!     unwinding, and provides a global allocator.
37//! - **seL4 Microkit**:
38//!   - [`sel4_microkit`]: A runtime for [seL4 Microkit](https://github.com/seL4/microkit)
39//!     protection domains, including an implementation of libmicrokit and abstractions for IPC.
40
41macro_rules! maybe {
42    {
43        #[cfg($condition:meta)]
44        $i:ident
45    } => {
46        #[cfg(not($condition))]
47        use absent as $i;
48        #[cfg($condition)]
49        pub use $i;
50    };
51}
52
53macro_rules! definitely {
54    ($($i:ident)*) => {
55        $(
56            pub use $i;
57        )*
58    }
59}
60
61macro_rules! mutually_exclusive {
62    ($tag:ident [$($feature:literal)*]) => {
63        mod $tag {
64            $(
65                #[cfg(feature = $feature)]
66                const $tag: () = ();
67            )*
68        }
69    }
70}
71
72mutually_exclusive! {
73    runtime_feature_check [
74        "sel4-root-task"
75        "sel4-microkit"
76    ]
77}
78
79/// Placeholder for crates which are not part of this view.
80pub mod absent {}
81
82definitely! {
83    sel4
84    sel4_sys
85    sel4_config
86
87    sel4_abstract_ptr
88    sel4_abstract_rc
89    sel4_async_block_io
90    sel4_async_block_io_fat
91    sel4_async_io
92    sel4_async_network
93    sel4_async_single_threaded_executor
94    sel4_async_time
95    sel4_async_unsync
96    sel4_abstract_allocator
97    sel4_dlmalloc
98    sel4_driver_interfaces
99    sel4_elf_header
100    sel4_immediate_sync_once_cell
101    sel4_immutable_cell
102    sel4_initialize_tls
103    sel4_logging
104    sel4_newlib
105    sel4_one_ref_cell
106    sel4_panicking
107    sel4_panicking_env
108}
109
110maybe! {
111    #[cfg(target_arch = "aarch64")]
112    sel4_reset
113}
114
115definitely! {
116    sel4_shared_memory
117    sel4_shared_ring_buffer
118    sel4_shared_ring_buffer_block_io
119    sel4_shared_ring_buffer_block_io_types
120    sel4_shared_ring_buffer_bookkeeping
121    sel4_shared_ring_buffer_smoltcp
122    sel4_stack
123    sel4_sync
124
125    sel4_bcm2835_aux_uart_driver
126    sel4_pl011_driver
127    sel4_pl031_driver
128    sel4_sp804_driver
129    sel4_virtio_net
130    sel4_virtio_blk
131    sel4_virtio_hal_impl
132}
133
134maybe! {
135    #[cfg(all(
136        feature = "sel4-platform-info",
137        not(target_arch = "x86_64")
138    ))]
139    sel4_platform_info
140}
141
142maybe! {
143    #[cfg(feature = "sel4-root-task")]
144    sel4_root_task
145}
146
147maybe! {
148    #[cfg(feature = "sel4-microkit")]
149    sel4_microkit
150}
151
152maybe! {
153    #[cfg(feature = "sel4-microkit")]
154    sel4_microkit_message
155}
156
157maybe! {
158    #[cfg(feature = "sel4-microkit")]
159    sel4_microkit_message_types
160}
meta/lib.rs

meta/
lib.rs
