Neotron Pico BIOS

This is the Neotron BIOS for the Neotron Pico board.

Compatibility

This BIOS will run on the Neotron Pico v1.0.0 and v1.1.0. Other boards based around the Raspberry Pi Pico could be supported with just a minor change to the pin configurations.

Hardware Features

The Neotron Pico PCB offers:

• Dual Cortex-M0+ clocked at 133 MHz 151.2 MHz
• 256 KiB RAM
• 2048 KiB Flash
• SD/MMC Slot
• 640x480 VGA output
• Stereo 16-bit 48 kHz audio
• Four Neotron expansion slots
• A dedicated Board Management Controller, offering:
  • Dual PS/2 ports
  • 5-wire 3.3V TTL UART
  • Power/reset control

Software Features

Currently the BIOS uses Core 0 for running the Neotron OS (and application code), and Core 1 for updating the video display and performing 80-column colour text rendering in real-time.

• 640x480 @ 60 Hz text mode
  • 80 columns, 60 rows, 8x8 font
  • 80 columns, 30 rows, 8x16 font
  • 16 foreground and 8 background colours
  • Fixed font
  • Loadable soft-font
• 640x400 @ 70 Hz text mode
  • 80 columns, 50 rows, 8x8 font
  • 80 columns, 25 rows, 8x16 font
  • 16 foreground and 8 background colours
  • Fixed font
  • Loadable soft-font
• 640x480 @ 60 Hz graphics mode
  • 1-bpp mode (2 colours) in 38 KiB
  • 2-bpp mode (4 colours) in 75 KiB
  • 4-bpp mode (4 colours) in 150 KiB
• 320x240 @ 60 Hz graphics mode
  • 1-bpp mode (2 colours) in 10 KiB
  • 2-bpp mode (4 colours) in 19 KiB
  • 4-bpp mode (4 colours) in 38 KiB
  • 8-bpp mode (8 colours) in 75 KiB
• SPI Bus
• I2C Bus
• SPI I/O Expander for Chip Selects and LEDs
• External Interrupts
• SD Card support
  • Read/write 512 byte blocks
  • Insert/remove detection
• Communications with the BMC
  • Reading from a PS/2 keyboard
  • Sending beeps/boops to the PC Speaker
  • Writing to the PS/2 keyboard
  • Reading/writing to/from the PS/2 mouse
  • UART support
  • Second I2C Bus support
  • Voltage monitoring
  • Soft-power
  • Soft-reset
• Dallas or Microchip RTC support
• Audio CODEC mixer programming
• I2S Audio Output
• I2S Audio Input

Programming

The Neotron BIOS uses the defmt crate to provide structured logging over the SWD interface. The easiest way to flash and debug your Neotron Pico BIOS is with a second Raspberry Pi Pico, or the official Raspberry Pi Debug Probe.

1. If your BMC has not been programmed, do that first.

2. Connect your Debugger Pico to the three DEBUG pins on the Neotron Pico, following the instructions for your particular debugging device or firmware.

3. If your Debugger Pico was a bare Pi Pico (and not a Debug Probe) then flash it with https://github.com/raspberrypi/picoprobe or https://github.com/majbthrd/DapperMime firmware (e.g. by copying the UF2 file to the USB Mass Storage device)

4. On your PC, install probe-rs, a microcontroller flashing tool.

   cargo install probe-rs --features=cli

5. Build the Neotron OS: We use the "neotron-flash-1002.ld" linker script to link it at 0x1002_0000.

   user@host ~/neotron-os $ cargo build --bin=flash1002 --release --target=thumbv6m-none-eabi
   user@host ~/neotron-os $ arm-none-eabi-objcopy -O binary ./target/thumbv6m-none-eabi/release/flash1002 ../neotron-pico-bios/src/thumbv6m-none-eabi-flash1002-libneotron_os.bin

6. Power on your Neotron Pico into bootloader mode by applying 12V, holding down the "BOOTSEL" button on the Raspberry Pi Pico and then and tapping the On/Off button on the Neotron.

   If you don't put the RP2040 into bootloader mode then when probe-rs resets the chip after programming, the firmware will detect it has had an incomplete reset and cause a full reset. This makes the video output more reliable, but the full reset will immediately disconnect probe-rs so you won't see any log messages. Booting the RP2040 in USB bootloader mode avoids this issue by making the probe-rs triggered reset look more like a full reset.

7. Build and load the Neotron BIOS, and view the debug output stream, with cargo run --release.

   user@host ~/neotron-pico-bios $ DEFMT_LOG=debug cargo run --release
     Compiling neotron-pico-bios v0.1.0 (/home/jonathan/Documents/neotron/neotron-pico-bios)
       Finished release [optimized + debuginfo] target(s) in 0.76s
       Running `probe-rs run --chip RP2040 target/thumbv6m-none-eabi/release/neotron-pico-bios`
   (HOST) INFO  flashing program (7.30 KiB)
   (HOST) INFO  success!
   ────────────────────────────────────────────────────────────────────────────────
   INFO  Neotron BIOS starting...
   └─ neotron_pico_bios::__cortex_m_rt_main @ src/main.rs:79
   INFO  Clocks OK
   └─ neotron_pico_bios::__cortex_m_rt_main @ src/main.rs:102
   INFO  Pins OK
   └─ neotron_pico_bios::__cortex_m_rt_main @ src/main.rs:121
   DEBUG Loop...
   └─ neotron_pico_bios::__cortex_m_rt_main @ src/main.rs:128

   You should see your Neotron Pico boot, both over RTT in the probe-rs output, and also on the VGA output.

Multiple Probes

If you have multiple probe-rs compatible probes attached to your computer, you will receive an error message.

You will need to check what probes are available and edit .cargo/config.toml to add the appropriate --probe VID:PID argument.

$ probe-rs list
the following probes were found:
[0]: Picoprobe CMSIS-DAP (VID: 2e8a, PID: 000c, Serial: Exxxxxxxxxxxxxx6, CmsisDap)
[1]: STLink V2 (VID: 0483, PID: 3748, Serial: 0xxxxxxxxxxxxxxxxxxxxxxE, StLink)
user@host ~/neotron-pico-bios $ $EDITOR .cargo/config.toml
user@host ~/neotron-pico-bios $ cat .cargo/config.toml | grep runner
# runner = "elf2uf2-rs -d"
# runner = "probe-rs run --chip RP2040"
runner = "probe-rs run --chip RP2040 --probe 2e8a:000c"

You can also just provide the probe Serial number, for example if you have multiple identical probes.

Changelog

See CHANGELOG.md

Licence

Neotron-Pico-BIOS Copyright (c) Jonathan 'theJPster' Pallant and the Neotron Developers, 2023

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

See the full text in LICENSE.txt. Broadly, we (the developers) interpret this to mean (and note that we are not lawyers and this is not legal advice) that if you give someone a Neotron Pico, you must also give them one of:

• Complete and corresponding source code (e.g. as a link to your own on-line Git repo) for any GPL components (e.g. the BIOS and the OS), as supplied on the Neotron Pico.
• A written offer to provide complete and corresponding source code on request.

If you are not offering Neotron Pico commercially (i.e. you are not selling the board for commercial gain), and you are using an unmodified upstream version of the source code, then the third option is to give them:

• A link to the tag/commit-hash on the relevant official Neotron Github repositories - https://github.com/Neotron-Compute/Neotron-Pico-BIOS and https://github.com/Neotron-Compute/Neotron-OS.

This is to ensure everyone always has the freedom to access the source code in their Neotron Pico.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be licensed as above, without any additional terms or conditions.