Default to externally powered RPis

Addresses issues in #86

Author: andre-richter

Diff for: 06_drivers_gpio_uart/README.md

@@ -49,23 +49,23 @@ init_uart_clock=48000000
     - [bootcode.bin](https://github.com/raspberrypi/firmware/raw/master/boot/bootcode.bin)
     - [fixup.dat](https://github.com/raspberrypi/firmware/raw/master/boot/fixup.dat)
     - [start.elf](https://github.com/raspberrypi/firmware/raw/master/boot/start.elf)
-4. Run `make` and copy the [kernel8.img](kernel8.img) onto the SD card.
+4. Run `make`.
 
 ### Pi 4
 
 3. Copy the following files from the [Raspberry Pi firmware repo](https://github.com/raspberrypi/firmware/tree/master/boot) onto the SD card:
     - [fixup4.dat](https://github.com/raspberrypi/firmware/raw/master/boot/fixup4.dat)
     - [start4.elf](https://github.com/raspberrypi/firmware/raw/master/boot/start4.elf)
     - [bcm2711-rpi-4-b.dtb](https://github.com/raspberrypi/firmware/raw/master/boot/bcm2711-rpi-4-b.dtb)
-4. Run `BSP=rpi4 make` and copy the [kernel8.img](kernel8.img) onto the SD card.
+4. Run `BSP=rpi4 make`.
+
 
 _**Note**: Should it not work on your RPi4, try renaming `start4.elf` to `start.elf` (without the 4)
 on the SD card._
 
 ### Common again
 
-5. Insert the SD card into the RPi and connect the USB serial to your host PC.
-    - Wiring diagram at [top-level README](../README.md#usb-serial).
+5. Copy the [kernel8.img](kernel8.img) onto the SD card and insert it back into the RPi.
 6. Run the `miniterm` target, which opens the UART device on the host:
 
 ```console
@@ -81,14 +81,16 @@ $ make miniterm
 $ DEV_SERIAL=/dev/tty.usbserial-0001 make miniterm
 ```
 
-7. Hit <kbd>Enter</kbd> after seeing "`Connected`" to kick off the kernel boot process and observe
-   the output:
+7. Connect the USB serial to your host PC.
+    - Wiring diagram at [top-level README](../README.md#usb-serial-output).
+    - Make sure that you **DID NOT** connect the power pin of the USB serial. Only RX/TX and GND.
+8. Connect the RPi to the (USB) power cable and observe the output:
 
 ```console
 Miniterm 1.0
 
-
-[MT] ✅ Connected
+[MT] ⏳ Waiting for /dev/ttyUSB0
+[MT] ✅ Serial connected
 [0] Booting on: Raspberry Pi 3
 [1] Drivers loaded:
       1. BCM GPIO
@@ -1212,7 +1214,7 @@ diff -uNr 05_safe_globals/src/main.rs 06_drivers_gpio_uart/src/main.rs
  mod memory;
  mod panic_wait;
  mod print;
-@@ -116,16 +126,53 @@
+@@ -116,16 +126,46 @@
  /// # Safety
  ///
  /// - Only a single core must be active and running this function.
@@ -1239,13 +1241,6 @@ diff -uNr 05_safe_globals/src/main.rs 06_drivers_gpio_uart/src/main.rs
 +    use console::interface::All;
 +    use driver::interface::DriverManager;
 +
-+    // Wait for user to hit Enter.
-+    loop {
-+        if bsp::console::console().read_char() == '\n' {
-+            break;
-+        }
-+    }
-+
 +    println!("[0] Booting on: {}", bsp::board_name());
 +
 +    println!("[1] Drivers loaded:");

Diff for: 06_drivers_gpio_uart/src/main.rs

@@ -147,13 +147,6 @@ fn kernel_main() -> ! {
     use console::interface::All;
     use driver::interface::DriverManager;
 
-    // Wait for user to hit Enter.
-    loop {
-        if bsp::console::console().read_char() == '\n' {
-            break;
-        }
-    }
-
     println!("[0] Booting on: {}", bsp::board_name());
 
     println!("[1] Drivers loaded:");

Diff for: 07_uart_chainloader/README.md

@@ -25,10 +25,13 @@ Our chainloader is called `MiniLoad` and is inspired by [raspbootin].
 
 You can try it with this tutorial already:
 1. Depending on your target hardware:`make` or `BSP=rpi4 make`.
-2. Copy `kernel8.img` to the SD card.
-3. Execute `make chainboot` or `BSP=rpi4 make chainboot`.
-4. Now plug in the USB Serial.
-5. Observe the loader fetching a kernel over `UART`:
+1. Copy `kernel8.img` to the SD card.
+1. Execute `make chainboot` or `BSP=rpi4 make chainboot`.
+1. Connect the USB serial to your host PC.
+    - Wiring diagram at [top-level README](../README.md#usb-serial-output).
+    - Make sure that you **DID NOT** connect the power pin of the USB serial. Only RX/TX and GND.
+1. Connect the RPi to the (USB) power cable.
+1. Observe the loader fetching a kernel over `UART`:
 
 > ❗ **NOTE**: By default, `make chainboot` tries to connect to `/dev/ttyUSB0`.
 > Should the USB serial on your system have a different name, you have to provide it explicitly. For
@@ -44,7 +47,8 @@ $ make chainboot
 Minipush 1.0
 
 [MP] ⏳ Waiting for /dev/ttyUSB0
-[MP] ✅ Connected
+[MP] ✅ Serial connected
+[MP] 🔌 Please power the target now
  __  __ _      _ _                 _
 |  \/  (_)_ _ (_) |   ___  __ _ __| |
 | |\/| | | ' \| | |__/ _ \/ _` / _` |
@@ -53,7 +57,7 @@ Minipush 1.0
            Raspberry Pi 3
 
 [ML] Requesting binary
-[MP] ⏩ Pushing 7 KiB ==========================================🦀 100% 0 KiB/s Time: 00:00:00
+[MP] ⏩ Pushing 6 KiB ==========================================🦀 100% 0 KiB/s Time: 00:00:00
 [ML] Loaded! Executing the payload now
 
 [0] Booting on: Raspberry Pi 3
@@ -429,18 +433,23 @@ diff -uNr 06_drivers_gpio_uart/src/main.rs 07_uart_chainloader/src/main.rs
  mod runtime_init;
  mod synchronization;
 
-@@ -144,35 +148,52 @@
+@@ -144,28 +148,52 @@
 
  /// The main function running after the early init.
  fn kernel_main() -> ! {
 +    use bsp::console::console;
      use console::interface::All;
 -    use driver::interface::DriverManager;
+-
+-    println!("[0] Booting on: {}", bsp::board_name());
 
--    // Wait for user to hit Enter.
--    loop {
--        if bsp::console::console().read_char() == '\n' {
--            break;
+-    println!("[1] Drivers loaded:");
+-    for (i, driver) in bsp::driver::driver_manager()
+-        .all_device_drivers()
+-        .iter()
+-        .enumerate()
+-    {
+-        println!("      {}. {}", i + 1, driver.compatible());
 +    println!(" __  __ _      _ _                 _ ");
 +    println!("|  \\/  (_)_ _ (_) |   ___  __ _ __| |");
 +    println!("| |\\/| | | ' \\| | |__/ _ \\/ _` / _` |");
@@ -458,8 +467,17 @@ diff -uNr 06_drivers_gpio_uart/src/main.rs 07_uart_chainloader/src/main.rs
 +    // Notify `Minipush` to send the binary.
 +    for _ in 0..3 {
 +        console().write_char(3 as char);
-+    }
-+
+     }
+
+-    println!(
+-        "[2] Chars written: {}",
+-        bsp::console::console().chars_written()
+-    );
+-    println!("[3] Echoing input now");
+-
+-    loop {
+-        let c = bsp::console::console().read_char();
+-        bsp::console::console().write_char(c);
 +    // Read the binary's size.
 +    let mut size: u32 = u32::from(console().read_char() as u8);
 +    size |= u32::from(console().read_char() as u8) << 8;
@@ -475,34 +493,15 @@ diff -uNr 06_drivers_gpio_uart/src/main.rs 07_uart_chainloader/src/main.rs
 +        // Read the kernel byte by byte.
 +        for i in 0..size {
 +            core::ptr::write_volatile(kernel_addr.offset(i as isize), console().read_char() as u8)
-         }
++        }
      }
-
--    println!("[0] Booting on: {}", bsp::board_name());
++
 +    println!("[ML] Loaded! Executing the payload now\n");
 +    console().flush();
-
--    println!("[1] Drivers loaded:");
--    for (i, driver) in bsp::driver::driver_manager()
--        .all_device_drivers()
--        .iter()
--        .enumerate()
--    {
--        println!("      {}. {}", i + 1, driver.compatible());
--    }
++
 +    // Use black magic to get a function pointer.
 +    let kernel: fn() -> ! = unsafe { core::mem::transmute(kernel_addr) };
-
--    println!(
--        "[2] Chars written: {}",
--        bsp::console::console().chars_written()
--    );
--    println!("[3] Echoing input now");
--
--    loop {
--        let c = bsp::console::console().read_char();
--        bsp::console::console().write_char(c);
--    }
++
 +    // Jump to loaded kernel!
 +    kernel()
  }
@@ -583,4 +582,18 @@ diff -uNr 06_drivers_gpio_uart/src/runtime_init.rs 07_uart_chainloader/src/runti
  pub unsafe fn runtime_init() -> ! {
      zero_bss();
 
+
+diff -uNr 06_drivers_gpio_uart/update.sh 07_uart_chainloader/update.sh
+--- 06_drivers_gpio_uart/update.sh
++++ 07_uart_chainloader/update.sh
+@@ -0,0 +1,8 @@
++#!/usr/bin/env bash
++
++cd ../06_drivers_gpio_uart
++BSP=rpi4 make
++cp kernel8.img ../07_uart_chainloader/demo_payload_rpi4.img
++make
++cp kernel8.img ../07_uart_chainloader/demo_payload_rpi3.img
++rm kernel8.img
+
 ```

Diff for: 07_uart_chainloader/demo_payload_rpi3.img

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+cd ../06_drivers_gpio_uart
+BSP=rpi4 make
+cp kernel8.img ../07_uart_chainloader/demo_payload_rpi4.img
+make
+cp kernel8.img ../07_uart_chainloader/demo_payload_rpi3.img
+rm kernel8.img

Diff for: 07_uart_chainloader/demo_payload_rpi4.img

@@ -15,7 +15,8 @@ $ make chainboot
 Minipush 1.0
 
 [MP] ⏳ Waiting for /dev/ttyUSB0
-[MP] ✅ Connected
+[MP] ✅ Serial connected
+[MP] 🔌 Please power the target now
  __  __ _      _ _                 _
 |  \/  (_)_ _ (_) |   ___  __ _ __| |
 | |\/| | | ' \| | |__/ _ \/ _` / _` |
@@ -24,19 +25,18 @@ Minipush 1.0
            Raspberry Pi 3
 
 [ML] Requesting binary
-[MP] ⏩ Pushing 12 KiB =========================================🦀 100% 0 KiB/s Time: 00:00:00
+[MP] ⏩ Pushing 11 KiB =========================================🦀 100% 0 KiB/s Time: 00:00:00
 [ML] Loaded! Executing the payload now
 
-[    0.586140] Booting on: Raspberry Pi 3
-[    0.587227] Architectural timer resolution: 52 ns
-[    0.589530] Drivers loaded:
-[    0.590876]       1. BCM GPIO
-[    0.592309]       2. BCM PL011 UART
-[W   0.594005] Spin duration smaller than architecturally supported, skipping
-[    0.597392] Spinning for 1 second
-[    1.599001] Spinning for 1 second
-[    2.599872] Spinning for 1 second
-
+[    0.543941] Booting on: Raspberry Pi 3
+[    0.545059] Architectural timer resolution: 52 ns
+[    0.547358] Drivers loaded:
+[    0.548703]       1. BCM GPIO
+[    0.550135]       2. BCM PL011 UART
+[W   0.551828] Spin duration smaller than architecturally supported, skipping
+[    0.555212] Spinning for 1 second
+[    1.556818] Spinning for 1 second
+[    2.557690] Spinning for 1 second
 ```
 
 ## Diff to previous
@@ -754,4 +754,17 @@ diff -uNr 07_uart_chainloader/src/time.rs 08_timestamps/src/time.rs
 +    }
 +}
 
+diff -uNr 07_uart_chainloader/update.sh 08_timestamps/update.sh
+--- 07_uart_chainloader/update.sh
++++ 08_timestamps/update.sh
+@@ -1,8 +0,0 @@
+-#!/usr/bin/env bash
+-
+-cd ../06_drivers_gpio_uart
+-BSP=rpi4 make
+-cp kernel8.img ../07_uart_chainloader/demo_payload_rpi4.img
+-make
+-cp kernel8.img ../07_uart_chainloader/demo_payload_rpi3.img
+-rm kernel8.img
+
 ```

Diff for: 07_uart_chainloader/update.sh

@@ -157,7 +157,8 @@ $ make jtagboot
 Minipush 1.0
 
 [MP] ⏳ Waiting for /dev/ttyUSB0
-[MP] ✅ Connected
+[MP] ✅ Serial connected
+[MP] 🔌 Please power the target now
  __  __ _      _ _                 _
 |  \/  (_)_ _ (_) |   ___  __ _ __| |
 | |\/| | | ' \| | |__/ _ \/ _` / _` |
@@ -166,10 +167,10 @@ Minipush 1.0
            Raspberry Pi 3
 
 [ML] Requesting binary
-[MP] ⏩ Pushing 8 KiB ==========================================🦀 100% 0 KiB/s Time: 00:00:00
+[MP] ⏩ Pushing 7 KiB ==========================================🦀 100% 0 KiB/s Time: 00:00:00
 [ML] Loaded! Executing the payload now
 
-[    0.372110] Parking CPU core. Please connect over JTAG now.
+[    0.394532] Parking CPU core. Please connect over JTAG now.
 ```
 
 It is important to keep the USB serial connected and the terminal with the `jtagboot` open and

Diff for: 08_timestamps/README.md

@@ -192,7 +192,8 @@ $ make chainboot
 Minipush 1.0
 
 [MP] ⏳ Waiting for /dev/ttyUSB0
-[MP] ✅ Connected
+[MP] ✅ Serial connected
+[MP] 🔌 Please power the target now
  __  __ _      _ _                 _
 |  \/  (_)_ _ (_) |   ___  __ _ __| |
 | |\/| | | ' \| | |__/ _ \/ _` / _` |
@@ -201,22 +202,22 @@ Minipush 1.0
            Raspberry Pi 3
 
 [ML] Requesting binary
-[MP] ⏩ Pushing 15 KiB =========================================🦀 100% 0 KiB/s Time: 00:00:00
+[MP] ⏩ Pushing 13 KiB =========================================🦀 100% 0 KiB/s Time: 00:00:00
 [ML] Loaded! Executing the payload now
 
-[    0.703812] Booting on: Raspberry Pi 3
-[    0.704900] Current privilege level: EL1
-[    0.706811] Exception handling state:
-[    0.708592]       Debug:  Masked
-[    0.710156]       SError: Masked
-[    0.711719]       IRQ:    Masked
-[    0.713283]       FIQ:    Masked
-[    0.714848] Architectural timer resolution: 52 ns
-[    0.717149] Drivers loaded:
-[    0.718496]       1. BCM GPIO
-[    0.719929]       2. BCM PL011 UART
-[    0.721623] Timer test, spinning for 1 second
-[    1.723753] Echoing input now
+[    0.637617] Booting on: Raspberry Pi 3
+[    0.638737] Current privilege level: EL1
+[    0.640645] Exception handling state:
+[    0.642424]       Debug:  Masked
+[    0.643986]       SError: Masked
+[    0.645548]       IRQ:    Masked
+[    0.647110]       FIQ:    Masked
+[    0.648672] Architectural timer resolution: 52 ns
+[    0.650971] Drivers loaded:
+[    0.652316]       1. BCM GPIO
+[    0.653748]       2. BCM PL011 UART
+[    0.655440] Timer test, spinning for 1 second
+[    1.657567] Echoing input now
 ```
 
 ## Diff to previous