From e172bed704f597f95c90cd2fc9bee8e69b2a4021 Mon Sep 17 00:00:00 2001 From: Daniel Schaefer Date: Wed, 10 Jun 2026 14:32:08 +0800 Subject: [PATCH 1/2] Document getting started Signed-off-by: Daniel Schaefer --- README.md | 23 ++++++++++++++++++++--- scripts/buspirate_ctrl.py | 4 ++++ 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 18e8d32..195c321 100644 --- a/README.md +++ b/README.md @@ -367,7 +367,24 @@ configured in the bios, the default is 115200 8N1. Normal boot keys like F2 and F12 should also work to interrupt the boot process. -## Dependencies +## Scripts -Note that on Fedora installing libftdi is not enough to satisfy the library dependencies -One has to install libftdi-devel +See [./scripts](./scripts) folder for scripts to capture logs, flash EC, ... + +## Buspirate + +A convenient tool for accessing EC and SOC UART is using the [Buspirate 5](https://buspirate.com/). + +To control it, use `./scripts/buspirate_ctrl.py`. + +Pre-requisites: + +- Clone submodules +- Python3 +- libftdi library and headers + +``` +git submodule update --init +sudo dnf install libfdti-devel +pip install -r BusPirate-BPIO2-flatbuffer-interface/python/requirements.txt +``` diff --git a/scripts/buspirate_ctrl.py b/scripts/buspirate_ctrl.py index 4528909..26bc38d 100755 --- a/scripts/buspirate_ctrl.py +++ b/scripts/buspirate_ctrl.py @@ -9,6 +9,10 @@ process can use it at a time. To control GPIO while a PTY bridge is running, use signals (see below) or combinable flags. +Initial setup: + git submodule update --init + pip install -r BusPirate-BPIO2-flatbuffer-interface/python/requirements.txt + Wiring: BP5 IO3 --> EC VCC1_RST (reset, active low) BP5 IO4 (TX) --> EC CR_SIN1 (UART RX) From 45f7608593ee65b5db6f7241c72f809f9d71d059 Mon Sep 17 00:00:00 2001 From: Daniel Schaefer Date: Fri, 18 Sep 2026 13:07:17 +0200 Subject: [PATCH 2/2] scripts: More detailed docs Signed-off-by: Daniel Schaefer --- README.md | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 195c321..f76a36a 100644 --- a/README.md +++ b/README.md @@ -377,14 +377,34 @@ A convenient tool for accessing EC and SOC UART is using the [Buspirate 5](https To control it, use `./scripts/buspirate_ctrl.py`. -Pre-requisites: - -- Clone submodules -- Python3 -- libftdi library and headers +### First time setup ``` +# Clone the submodules git submodule update --init + +# Install libftdi library and header (Example for Fedora) sudo dnf install libfdti-devel + +# Suggested to use venv +# Create the venv +python3 -m venv .venv +# Enter the venv +source .venv/bin/activate + +# Install python dependencies pip install -r BusPirate-BPIO2-flatbuffer-interface/python/requirements.txt + +# Add yourself to the dialout group to avoid sudo (Need to log in again) +sudo usermod -a -G dialout $(whoami) +``` + +### Usage + +``` +# Enter venv (if created above) +source .venv/bin/activate + +# Example: Reset the EC and print the log +./buspirate_ctrl.py --reset --log ```