Skip to content

Commit fec4f9b

Browse files
andre-richterandre-richter
committed
Rework driver subsystem
- Remove the panic version of the GPIO and UART driver. While they were a neat idea, it proved tedious to drag them along different tutorials where the virtual memory situation kept on changing. Actually, not much is lost, since the benefit was only of theoretical nature until now, since everything is still single-threaded with NullLocks. It is still possible to re-introduce them later. - Refactor driver bringup starting with tutorial 14. Instantiating the drivers only when we are already capable of using the remapped MMIO address makes the kernel a lot more robust, and the drivers need not care whether their MMIO addresses are good to use already or not. - Use console and irq_manager references from the generic kernel code. This improves decoupling from the BSP, and is needed as a basis for tutorial 14.
1 parent 4ab609b commit fec4f9b

File tree

284 files changed

+4839
-4643
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

284 files changed

+4839
-4643
lines changed

‎.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
**/kernel8.img
44

55
node_modules
6+
.bundle
67
.vendor
78

89
Gemfile.lock
9-
package-lock.json
10+
package*.json

‎03_hacky_hello_world/README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,13 +188,15 @@ diff -uNr 02_runtime_init/src/bsp/raspberrypi.rs 03_hacky_hello_world/src/bsp/ra
188188
diff -uNr 02_runtime_init/src/console.rs 03_hacky_hello_world/src/console.rs
189189
--- 02_runtime_init/src/console.rs
190190
+++ 03_hacky_hello_world/src/console.rs
191-
@@ -0,0 +1,19 @@
191+
@@ -0,0 +1,32 @@
192192
+// SPDX-License-Identifier: MIT OR Apache-2.0
193193
+//
194194
+// Copyright (c) 2018-2022 Andre Richter <[email protected]>
195195
+
196196
+//! System console.
197197
+
198+
+use crate::bsp;
199+
+
198200
+//--------------------------------------------------------------------------------------------------
199201
+// Public Definitions
200202
+//--------------------------------------------------------------------------------------------------
@@ -208,6 +210,17 @@ diff -uNr 02_runtime_init/src/console.rs 03_hacky_hello_world/src/console.rs
208210
+ /// intention.
209211
+ pub use core::fmt::Write;
210212
+}
213+
+
214+
+//--------------------------------------------------------------------------------------------------
215+
+// Public Code
216+
+//--------------------------------------------------------------------------------------------------
217+
+
218+
+/// Return a reference to the console.
219+
+///
220+
+/// This is the global console used by all printing macros.
221+
+pub fn console() -> impl interface::Write {
222+
+ bsp::console::console()
223+
+}
211224

212225
diff -uNr 02_runtime_init/src/main.rs 03_hacky_hello_world/src/main.rs
213226
--- 02_runtime_init/src/main.rs
@@ -317,7 +330,7 @@ diff -uNr 02_runtime_init/src/print.rs 03_hacky_hello_world/src/print.rs
317330
+
318331
+//! Printing.
319332
+
320-
+use crate::{bsp, console};
333+
+use crate::console;
321334
+use core::fmt;
322335
+
323336
+//--------------------------------------------------------------------------------------------------
@@ -328,7 +341,7 @@ diff -uNr 02_runtime_init/src/print.rs 03_hacky_hello_world/src/print.rs
328341
+pub fn _print(args: fmt::Arguments) {
329342
+ use console::interface::Write;
330343
+
331-
+ bsp::console::console().write_fmt(args).unwrap();
344+
+ console::console().write_fmt(args).unwrap();
332345
+}
333346
+
334347
+/// Prints without a newline.

‎03_hacky_hello_world/src/console.rs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
//! System console.
66
7+
use crate::bsp;
8+
79
//--------------------------------------------------------------------------------------------------
810
// Public Definitions
911
//--------------------------------------------------------------------------------------------------
@@ -17,3 +19,14 @@ pub mod interface {
1719
/// intention.
1820
pub use core::fmt::Write;
1921
}
22+
23+
//--------------------------------------------------------------------------------------------------
24+
// Public Code
25+
//--------------------------------------------------------------------------------------------------
26+
27+
/// Return a reference to the console.
28+
///
29+
/// This is the global console used by all printing macros.
30+
pub fn console() -> impl interface::Write {
31+
bsp::console::console()
32+
}

‎03_hacky_hello_world/src/print.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
//! Printing.
66
7-
use crate::{bsp, console};
7+
use crate::console;
88
use core::fmt;
99

1010
//--------------------------------------------------------------------------------------------------
@@ -15,7 +15,7 @@ use core::fmt;
1515
pub fn _print(args: fmt::Arguments) {
1616
use console::interface::Write;
1717

18-
bsp::console::console().write_fmt(args).unwrap();
18+
console::console().write_fmt(args).unwrap();
1919
}
2020

2121
/// Prints without a newline.

‎04_safe_globals/README.md

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ diff -uNr 03_hacky_hello_world/src/bsp/raspberrypi/console.rs 04_safe_globals/sr
148148
}
149149

150150
Ok(())
151-
@@ -41,7 +80,37 @@
151+
@@ -41,7 +80,39 @@
152152
// Public Code
153153
//--------------------------------------------------------------------------------------------------
154154

@@ -164,9 +164,9 @@ diff -uNr 03_hacky_hello_world/src/bsp/raspberrypi/console.rs 04_safe_globals/sr
164164
/// Return a reference to the console.
165165
-pub fn console() -> impl console::interface::Write {
166166
- QEMUOutput {}
167-
+pub fn console() -> &'static impl console::interface::All {
167+
+pub fn console() -> &'static dyn console::interface::All {
168168
+ &QEMU_OUTPUT
169-
+}
169+
}
170170
+
171171
+//------------------------------------------------------------------------------
172172
+// OS Interface Code
@@ -187,12 +187,14 @@ diff -uNr 03_hacky_hello_world/src/bsp/raspberrypi/console.rs 04_safe_globals/sr
187187
+ fn chars_written(&self) -> usize {
188188
+ self.inner.lock(|inner| inner.chars_written)
189189
+ }
190-
}
190+
+}
191+
+
192+
+impl console::interface::All for QEMUOutput {}
191193

192194
diff -uNr 03_hacky_hello_world/src/console.rs 04_safe_globals/src/console.rs
193195
--- 03_hacky_hello_world/src/console.rs
194196
+++ 04_safe_globals/src/console.rs
195-
@@ -10,10 +10,22 @@
197+
@@ -12,12 +12,24 @@
196198

197199
/// Console interfaces.
198200
pub mod interface {
@@ -218,7 +220,17 @@ diff -uNr 03_hacky_hello_world/src/console.rs 04_safe_globals/src/console.rs
218220
+ }
219221
+
220222
+ /// Trait alias for a full-fledged console.
221-
+ pub trait All = Write + Statistics;
223+
+ pub trait All: Write + Statistics {}
224+
}
225+
226+
//--------------------------------------------------------------------------------------------------
227+
@@ -27,6 +39,6 @@
228+
/// Return a reference to the console.
229+
///
230+
/// This is the global console used by all printing macros.
231+
-pub fn console() -> impl interface::Write {
232+
+pub fn console() -> &'static dyn interface::All {
233+
bsp::console::console()
222234
}
223235

224236
diff -uNr 03_hacky_hello_world/src/main.rs 04_safe_globals/src/main.rs
@@ -240,25 +252,35 @@ diff -uNr 03_hacky_hello_world/src/main.rs 04_safe_globals/src/main.rs
240252

241253
/// Early init code.
242254
///
243-
@@ -124,7 +126,15 @@
255+
@@ -124,7 +126,12 @@
244256
///
245257
/// - Only a single core must be active and running this function.
246258
unsafe fn kernel_init() -> ! {
247259
- println!("Hello from Rust!");
248-
+ use console::interface::Statistics;
260+
+ use console::console;
249261

250262
- panic!("Stopping here.")
251263
+ println!("[0] Hello from Rust!");
252264
+
253-
+ println!(
254-
+ "[1] Chars written: {}",
255-
+ bsp::console::console().chars_written()
256-
+ );
265+
+ println!("[1] Chars written: {}", console().chars_written());
257266
+
258267
+ println!("[2] Stopping here.");
259268
+ cpu::wait_forever()
260269
}
261270

271+
diff -uNr 03_hacky_hello_world/src/print.rs 04_safe_globals/src/print.rs
272+
--- 03_hacky_hello_world/src/print.rs
273+
+++ 04_safe_globals/src/print.rs
274+
@@ -13,8 +13,6 @@
275+
276+
#[doc(hidden)]
277+
pub fn _print(args: fmt::Arguments) {
278+
- use console::interface::Write;
279+
-
280+
console::console().write_fmt(args).unwrap();
281+
}
282+
283+
262284
diff -uNr 03_hacky_hello_world/src/synchronization.rs 04_safe_globals/src/synchronization.rs
263285
--- 03_hacky_hello_world/src/synchronization.rs
264286
+++ 04_safe_globals/src/synchronization.rs

‎04_safe_globals/src/bsp/raspberrypi/console.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ impl QEMUOutput {
9090
}
9191

9292
/// Return a reference to the console.
93-
pub fn console() -> &'static impl console::interface::All {
93+
pub fn console() -> &'static dyn console::interface::All {
9494
&QEMU_OUTPUT
9595
}
9696

@@ -114,3 +114,5 @@ impl console::interface::Statistics for QEMUOutput {
114114
self.inner.lock(|inner| inner.chars_written)
115115
}
116116
}
117+
118+
impl console::interface::All for QEMUOutput {}

‎04_safe_globals/src/console.rs

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
//! System console.
66
7+
use crate::bsp;
8+
79
//--------------------------------------------------------------------------------------------------
810
// Public Definitions
911
//--------------------------------------------------------------------------------------------------
@@ -27,5 +29,16 @@ pub mod interface {
2729
}
2830

2931
/// Trait alias for a full-fledged console.
30-
pub trait All = Write + Statistics;
32+
pub trait All: Write + Statistics {}
33+
}
34+
35+
//--------------------------------------------------------------------------------------------------
36+
// Public Code
37+
//--------------------------------------------------------------------------------------------------
38+
39+
/// Return a reference to the console.
40+
///
41+
/// This is the global console used by all printing macros.
42+
pub fn console() -> &'static dyn interface::All {
43+
bsp::console::console()
3144
}

‎04_safe_globals/src/main.rs

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,14 +126,11 @@ mod synchronization;
126126
///
127127
/// - Only a single core must be active and running this function.
128128
unsafe fn kernel_init() -> ! {
129-
use console::interface::Statistics;
129+
use console::console;
130130

131131
println!("[0] Hello from Rust!");
132132

133-
println!(
134-
"[1] Chars written: {}",
135-
bsp::console::console().chars_written()
136-
);
133+
println!("[1] Chars written: {}", console().chars_written());
137134

138135
println!("[2] Stopping here.");
139136
cpu::wait_forever()

‎04_safe_globals/src/print.rs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
//! Printing.
66
7-
use crate::{bsp, console};
7+
use crate::console;
88
use core::fmt;
99

1010
//--------------------------------------------------------------------------------------------------
@@ -13,9 +13,7 @@ use core::fmt;
1313

1414
#[doc(hidden)]
1515
pub fn _print(args: fmt::Arguments) {
16-
use console::interface::Write;
17-
18-
bsp::console::console().write_fmt(args).unwrap();
16+
console::console().write_fmt(args).unwrap();
1917
}
2018

2119
/// Prints without a newline.

0 commit comments

Comments
 (0)