Skip to content

Commit e172bed

Browse files
committed
Document getting started
Signed-off-by: Daniel Schaefer <dhs@frame.work>
1 parent 81b7ccf commit e172bed

2 files changed

Lines changed: 24 additions & 3 deletions

File tree

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,24 @@ configured in the bios, the default is 115200 8N1.
367367
Normal boot keys like F2 and F12 should also work to interrupt the boot process.
368368

369369

370-
## Dependencies
370+
## Scripts
371371

372-
Note that on Fedora installing libftdi is not enough to satisfy the library dependencies
373-
One has to install libftdi-devel
372+
See [./scripts](./scripts) folder for scripts to capture logs, flash EC, ...
373+
374+
## Buspirate
375+
376+
A convenient tool for accessing EC and SOC UART is using the [Buspirate 5](https://buspirate.com/).
377+
378+
To control it, use `./scripts/buspirate_ctrl.py`.
379+
380+
Pre-requisites:
381+
382+
- Clone submodules
383+
- Python3
384+
- libftdi library and headers
385+
386+
```
387+
git submodule update --init
388+
sudo dnf install libfdti-devel
389+
pip install -r BusPirate-BPIO2-flatbuffer-interface/python/requirements.txt
390+
```

scripts/buspirate_ctrl.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
process can use it at a time. To control GPIO while a PTY bridge is
1010
running, use signals (see below) or combinable flags.
1111
12+
Initial setup:
13+
git submodule update --init
14+
pip install -r BusPirate-BPIO2-flatbuffer-interface/python/requirements.txt
15+
1216
Wiring:
1317
BP5 IO3 --> EC VCC1_RST (reset, active low)
1418
BP5 IO4 (TX) --> EC CR_SIN1 (UART RX)

0 commit comments

Comments
 (0)