pikvm-atx

This project was created from the rp2040-project-template project.

This project allows for the control of multiple ATX power commands from a single PiKVM unit. The Raspberry Pi Pico microcontroller is used to create a serial over USB port on the host PiKVM unit. PiKVM unit can send byte arrays to tell the pico which computer's ATX command to execute, and for how long.

Currently only supports 4 servers to match the 4 outputs of the Ezcoo swtich. The GPIO pins are specified here

Adding plugin and web UI support to the PiKVM project is currently in progress. The send-atx-command.py script is provided to achieve the comms. Copy the script to the PiKVM unit and install pyserial pacman -Sy python3-pyserial

Table of Contents

1. Requirements
2. Bill Of Materials
3. Installation of development dependencies
4. Running
5. Alternative runners
6. Contributing
7. Code of conduct

Requirements

• The standard Rust tooling (cargo, rustup) which you can install from https://rustup.rs/

• Toolchain support for the cortex-m0+ processors in the rp2040 (thumbv6m-none-eabi)

• flip-link - this allows you to detect stack-overflows on the first core, which is the only supported target for now.

• probe-run. Upstream support for RP2040 was added with version 0.3.1.

• A CMSIS-DAP probe. (J-Link and other probes will not work with probe-run)

  You can use a second Pico as a CMSIS-DAP debug probe. Details on other supported debug probes can be found in debug_probes.md

Bill Of Materials

• Raspberry Pi Pico
• Breadboard and wires
• ATX Adapter Board
• (optional, can use other switches) Ezcoo KVM Switch

Installation of development dependencies

rustup target install thumbv6m-none-eabi
cargo install flip-link
# This is our suggested default 'runner'
cargo install probe-run
# If you want to use elf2uf2-rs instead of probe-run, instead do...
cargo install elf2uf2-rs --locked

Running

For a debug build

cargo run

For a release build

cargo run --release

If you do not specify a DEFMT_LOG level, it will be set to debug. That means println!(""), info!("") and debug!("") statements will be printed. If you wish to override this, you can change it in .cargo/config.toml

[env]
DEFMT_LOG = "off"

You can also set this inline (on Linux/MacOS)

DEFMT_LOG=trace cargo run

or set the environment variable so that it applies to every cargo run call that follows:

Linux/MacOS/unix

export DEFMT_LOG=trace

Setting the DEFMT_LOG level for the current session
for bash

export DEFMT_LOG=trace

Windows

Windows users can only override DEFMT_LOG through config.toml or by setting the environment variable as a separate step before calling cargo run

• cmd

set DEFMT_LOG=trace

• powershell

$Env:DEFMT_LOG = trace

cargo run

Alternative runners

If you don't have a debug probe or if you want to do interactive debugging you can set up an alternative runner for cargo.

Some of the options for your runner are listed below:

• cargo embed
  Step 1 - Install cargo embed:

  $ cargo install cargo-embed

  Step 2 - Make sure your .cargo/config contains the following

  [target.thumbv6m-none-eabi]
  runner = "cargo embed"

  Step 3 - Update settings in Embed.toml

  • The defaults are to flash, reset, and start a defmt logging session You can find all the settings and their meanings in the cargo-embed repo

  Step 4 - Use cargo run, which will compile the code and start the specified 'runner'. As the 'runner' is cargo embed, it will flash the device and start running immediately

  $ cargo run --release

• probe-rs-debugger

  Step 1 - Download probe-rs-debugger VSCode plugin 0.4.0

  Step 2 - Install probe-rs-debugger VSCode plugin

  $ code --install-extension probe-rs-debugger-0.4.0.vsix

  Step 3 - Install probe-rs-debugger

  $ cargo install probe-rs-debugger

  Step 4 - Open this project in VSCode

  Step 5 - Launch a debug session by choosing Run>Start Debugging (or press F5)

• Loading a UF2 over USB
  Step 1 - Install elf2uf2-rs:

  $ cargo install elf2uf2-rs --locked

  Step 2 - Make sure your .cargo/config contains the following

  [target.thumbv6m-none-eabi]
  runner = "elf2uf2-rs -d"

  The thumbv6m-none-eabi target may be replaced by the all-Arm wildcard 'cfg(all(target_arch = "arm", target_os = "none"))'.

  Step 3 - Boot your RP2040 into "USB Bootloader mode", typically by rebooting whilst holding some kind of "Boot Select" button. On Linux, you will also need to 'mount' the device, like you would a USB Thumb Drive.

  Step 4 - Use cargo run, which will compile the code and start the specified 'runner'. As the 'runner' is the elf2uf2-rs tool, it will build a UF2 file and copy it to your RP2040.

  $ cargo run --release

• Loading with picotool
  As ELF files produced by compiling Rust code are completely compatible with ELF files produced by compiling C or C++ code, you can also use the Raspberry Pi tool picotool. The only thing to be aware of is that picotool expects your ELF files to have a .elf extension, and by default Rust does not give the ELF files any extension. You can fix this by simply renaming the file.

  This means you can't easily use it as a cargo runner - yet.

  Also of note is that the special pico-sdk macros which hide information in the ELF file in a way that picotool info can read it out, are not supported in Rust. An alternative is TBC.

Code of Conduct

Contribution to this crate is organized under the terms of the Rust Code of Conduct, and the maintainer of this crate, the rp-rs team, promises to intervene to uphold that code of conduct.